Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Helpers;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Class Crawl_Cleanup_Helper.

[5] Fix | Delete

[6] Fix | Delete

* Used by the Crawl_Cleanup_Permalinks class.

[7] Fix | Delete

[8] Fix | Delete

class Crawl_Cleanup_Helper {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* The current page helper

[12] Fix | Delete

[13] Fix | Delete

* @var Current_Page_Helper

[14] Fix | Delete

[15] Fix | Delete

private $current_page_helper;

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* The options helper.

[19] Fix | Delete

[20] Fix | Delete

* @var Options_Helper

[21] Fix | Delete

[22] Fix | Delete

private $options_helper;

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* The URL helper.

[26] Fix | Delete

[27] Fix | Delete

* @var Url_Helper

[28] Fix | Delete

[29] Fix | Delete

private $url_helper;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* The Redirect Helper.

[33] Fix | Delete

[34] Fix | Delete

* @var Redirect_Helper

[35] Fix | Delete

[36] Fix | Delete

private $redirect_helper;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Crawl Cleanup Basic integration constructor.

[40] Fix | Delete

[41] Fix | Delete

* @param Current_Page_Helper $current_page_helper The current page helper.

[42] Fix | Delete

* @param Options_Helper $options_helper The option helper.

[43] Fix | Delete

* @param Url_Helper $url_helper The URL helper.

[44] Fix | Delete

* @param Redirect_Helper $redirect_helper The Redirect Helper.

[45] Fix | Delete

[46] Fix | Delete

public function __construct(

[47] Fix | Delete

Current_Page_Helper $current_page_helper,

[48] Fix | Delete

Options_Helper $options_helper,

[49] Fix | Delete

Url_Helper $url_helper,

[50] Fix | Delete

Redirect_Helper $redirect_helper

[51] Fix | Delete

) {

[52] Fix | Delete

$this->current_page_helper = $current_page_helper;

[53] Fix | Delete

$this->options_helper = $options_helper;

[54] Fix | Delete

$this->url_helper = $url_helper;

[55] Fix | Delete

$this->redirect_helper = $redirect_helper;

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Checks if the current URL is not robots, sitemap, empty or user is logged in.

[60] Fix | Delete

[61] Fix | Delete

* @return bool True if the current URL is a valid URL.

[62] Fix | Delete

[63] Fix | Delete

public function should_avoid_redirect() {

[64] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We're not processing anything yet...

[65] Fix | Delete

if ( \is_robots() || \get_query_var( 'sitemap' ) || empty( $_GET ) || \is_user_logged_in() ) {

[66] Fix | Delete

return true;

[67] Fix | Delete

}

[68] Fix | Delete

return false;

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Returns the list of the allowed extra vars.

[73] Fix | Delete

[74] Fix | Delete

* @return array The list of the allowed extra vars.

[75] Fix | Delete

[76] Fix | Delete

public function get_allowed_extravars() {

[77] Fix | Delete

$default_allowed_extravars = [

[78] Fix | Delete

'utm_source',

[79] Fix | Delete

'utm_medium',

[80] Fix | Delete

'utm_campaign',

[81] Fix | Delete

'utm_term',

[82] Fix | Delete

'utm_content',

[83] Fix | Delete

'gclid',

[84] Fix | Delete

'gtm_debug',

[85] Fix | Delete

];

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Filter: 'Yoast\WP\SEO\allowlist_permalink_vars' - Allows plugins to register their own variables not to clean.

[89] Fix | Delete

[90] Fix | Delete

* @since 19.2.0

[91] Fix | Delete

[92] Fix | Delete

* @param array $allowed_extravars The list of the allowed vars (empty by default).

[93] Fix | Delete

[94] Fix | Delete

$allowed_extravars = \apply_filters( 'Yoast\WP\SEO\allowlist_permalink_vars', $default_allowed_extravars );

[95] Fix | Delete

[96] Fix | Delete

$clean_permalinks_extra_variables = $this->options_helper->get( 'clean_permalinks_extra_variables' );

[97] Fix | Delete

[98] Fix | Delete

if ( $clean_permalinks_extra_variables !== '' ) {

[99] Fix | Delete

$allowed_extravars = \array_merge( $allowed_extravars, \explode( ',', $clean_permalinks_extra_variables ) );

[100] Fix | Delete

}

[101] Fix | Delete

return $allowed_extravars;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

/**

[105] Fix | Delete

* Gets the allowed query vars from the current URL.

[106] Fix | Delete

[107] Fix | Delete

* @param string $current_url The current URL.

[108] Fix | Delete

* @return array is_allowed and allowed_query.

[109] Fix | Delete

[110] Fix | Delete

public function allowed_params( $current_url ) {

[111] Fix | Delete

// This is a Premium plugin-only function: Allows plugins to register their own variables not to clean.

[112] Fix | Delete

$allowed_extravars = $this->get_allowed_extravars();

[113] Fix | Delete

[114] Fix | Delete

$allowed_query = [];

[115] Fix | Delete

[116] Fix | Delete

$parsed_url = \wp_parse_url( $current_url, \PHP_URL_QUERY );

[117] Fix | Delete

[118] Fix | Delete

$query = $this->url_helper->parse_str_params( $parsed_url );

[119] Fix | Delete

[120] Fix | Delete

if ( ! empty( $allowed_extravars ) ) {

[121] Fix | Delete

foreach ( $allowed_extravars as $get ) {

[122] Fix | Delete

$get = \trim( $get );

[123] Fix | Delete

if ( isset( $query[ $get ] ) ) {

[124] Fix | Delete

$allowed_query[ $get ] = \rawurlencode_deep( $query[ $get ] );

[125] Fix | Delete

unset( $query[ $get ] );

[126] Fix | Delete

}

[127] Fix | Delete

}

[128] Fix | Delete

}

[129] Fix | Delete

return [

[130] Fix | Delete

'query' => $query,

[131] Fix | Delete

'allowed_query' => $allowed_query,

[132] Fix | Delete

];

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Returns the proper URL for singular pages.

[137] Fix | Delete

[138] Fix | Delete

* @return string The proper URL.

[139] Fix | Delete

[140] Fix | Delete

public function singular_url() {

[141] Fix | Delete

[142] Fix | Delete

global $post;

[143] Fix | Delete

$proper_url = \get_permalink( $post->ID );

[144] Fix | Delete

$page = \get_query_var( 'page' );

[145] Fix | Delete

[146] Fix | Delete

if ( $page && $page !== 1 ) {

[147] Fix | Delete

$the_post = \get_post( $post->ID );

[148] Fix | Delete

$page_count = \substr_count( $the_post->post_content, '' );

[149] Fix | Delete

$proper_url = \user_trailingslashit( \trailingslashit( $proper_url ) . $page );

[150] Fix | Delete

if ( $page > ( $page_count + 1 ) ) {

[151] Fix | Delete

$proper_url = \user_trailingslashit( \trailingslashit( $proper_url ) . ( $page_count + 1 ) );

[152] Fix | Delete

}

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

// Fix reply to comment links, whoever decided this should be a GET variable?

[156] Fix | Delete

// phpcs:ignore WordPress.Security -- We know this is scary.

[157] Fix | Delete

if ( isset( $_SERVER['REQUEST_URI'] ) && \preg_match( '`(\?replytocom=[^&]+)`', \sanitize_text_field( $_SERVER['REQUEST_URI'] ), $matches ) ) {

[158] Fix | Delete

$proper_url .= \str_replace( '?replytocom=', '#comment-', $matches[0] );

[159] Fix | Delete

}

[160] Fix | Delete

unset( $matches );

[161] Fix | Delete

[162] Fix | Delete

return $proper_url;

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Returns the proper URL for front page.

[167] Fix | Delete

[168] Fix | Delete

* @return string The proper URL.

[169] Fix | Delete

[170] Fix | Delete

public function front_page_url() {

[171] Fix | Delete

if ( $this->current_page_helper->is_home_posts_page() ) {

[172] Fix | Delete

return \home_url( '/' );

[173] Fix | Delete

}

[174] Fix | Delete

if ( $this->current_page_helper->is_home_static_page() ) {

[175] Fix | Delete

return \get_permalink( $GLOBALS['post']->ID );

[176] Fix | Delete

}

[177] Fix | Delete

return '';

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/**

[181] Fix | Delete

* Returns the proper URL for 404 page.

[182] Fix | Delete

[183] Fix | Delete

* @param string $current_url The current URL.

[184] Fix | Delete

* @return string The proper URL.

[185] Fix | Delete

[186] Fix | Delete

public function page_not_found_url( $current_url ) {

[187] Fix | Delete

if ( ! \is_multisite() || \is_subdomain_install() || ! \is_main_site() ) {

[188] Fix | Delete

return '';

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

if ( $current_url !== \home_url() . '/blog/' && $current_url !== \home_url() . '/blog' ) {

[192] Fix | Delete

return '';

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

if ( $this->current_page_helper->is_home_static_page() ) {

[196] Fix | Delete

return \get_permalink( \get_option( 'page_for_posts' ) );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

return \home_url();

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Returns the proper URL for taxonomy page.

[204] Fix | Delete

[205] Fix | Delete

* @return string The proper URL.

[206] Fix | Delete

[207] Fix | Delete

public function taxonomy_url() {

[208] Fix | Delete

global $wp_query;

[209] Fix | Delete

$term = $wp_query->get_queried_object();

[210] Fix | Delete

[211] Fix | Delete

if ( \is_feed() ) {

[212] Fix | Delete

return \get_term_feed_link( $term->term_id, $term->taxonomy );

[213] Fix | Delete

}

[214] Fix | Delete

return \get_term_link( $term, $term->taxonomy );

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Returns the proper URL for search page.

[219] Fix | Delete

[220] Fix | Delete

* @return string The proper URL.

[221] Fix | Delete

[222] Fix | Delete

public function search_url() {

[223] Fix | Delete

$s = \get_search_query();

[224] Fix | Delete

return \home_url() . '/?s=' . \rawurlencode( $s );

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

/**

[228] Fix | Delete

* Returns the proper URL for url with page param.

[229] Fix | Delete

[230] Fix | Delete

* @param string $proper_url The proper URL.

[231] Fix | Delete

* @return string The proper URL.

[232] Fix | Delete

[233] Fix | Delete

public function query_var_page_url( $proper_url ) {

[234] Fix | Delete

global $wp_query;

[235] Fix | Delete

if ( \is_search( $proper_url ) ) {

[236] Fix | Delete

return \home_url() . '/page/' . $wp_query->query_vars['paged'] . '/?s=' . \rawurlencode( \get_search_query() );

[237] Fix | Delete

}

[238] Fix | Delete

return \user_trailingslashit( \trailingslashit( $proper_url ) . 'page/' . $wp_query->query_vars['paged'] );

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

/**

[242] Fix | Delete

* Returns true if query is with page param.

[243] Fix | Delete

[244] Fix | Delete

* @param string $proper_url The proper URL.

[245] Fix | Delete

* @return bool is query with page param.

[246] Fix | Delete

[247] Fix | Delete

public function is_query_var_page( $proper_url ) {

[248] Fix | Delete

global $wp_query;

[249] Fix | Delete

if ( empty( $proper_url ) || $wp_query->query_vars['paged'] === 0 || $wp_query->post_count === 0 ) {

[250] Fix | Delete

return false;

[251] Fix | Delete

}

[252] Fix | Delete

return true;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Redirects clean permalink.

[257] Fix | Delete

[258] Fix | Delete

* @param string $proper_url The proper URL.

[259] Fix | Delete

* @return void

[260] Fix | Delete

[261] Fix | Delete

public function do_clean_redirect( $proper_url ) {

[262] Fix | Delete

$this->redirect_helper->set_header( 'Content-Type: redirect', true );

[263] Fix | Delete

$this->redirect_helper->remove_header( 'Content-Type' );

[264] Fix | Delete

$this->redirect_helper->remove_header( 'Last-Modified' );

[265] Fix | Delete

$this->redirect_helper->remove_header( 'X-Pingback' );

[266] Fix | Delete

[267] Fix | Delete

$message = \sprintf(

[268] Fix | Delete

/* translators: %1$s: Yoast SEO */

[269] Fix | Delete

\__( '%1$s: unregistered URL parameter removed. See %2$s', 'wordpress-seo' ),

[270] Fix | Delete

'Yoast SEO',

[271] Fix | Delete

'https://yoa.st/advanced-crawl-settings'

[272] Fix | Delete

);

[273] Fix | Delete

[274] Fix | Delete

$this->redirect_helper->do_safe_redirect( $proper_url, 301, $message );

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete

/**

[278] Fix | Delete

* Gets the type of URL.

[279] Fix | Delete

[280] Fix | Delete

* @return string The type of URL.

[281] Fix | Delete

[282] Fix | Delete

public function get_url_type() {

[283] Fix | Delete

if ( \is_singular() ) {

[284] Fix | Delete

return 'singular_url';

[285] Fix | Delete

}

[286] Fix | Delete

if ( \is_front_page() ) {

[287] Fix | Delete

return 'front_page_url';

[288] Fix | Delete

}

[289] Fix | Delete

if ( $this->current_page_helper->is_posts_page() ) {

[290] Fix | Delete

return 'page_for_posts_url';

[291] Fix | Delete

}

[292] Fix | Delete

if ( \is_category() || \is_tag() || \is_tax() ) {

[293] Fix | Delete

return 'taxonomy_url';

[294] Fix | Delete

}

[295] Fix | Delete

if ( \is_search() ) {

[296] Fix | Delete

return 'search_url';

[297] Fix | Delete

}

[298] Fix | Delete

if ( \is_404() ) {

[299] Fix | Delete

return 'page_not_found_url';

[300] Fix | Delete

}

[301] Fix | Delete

return '';

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

/**

[305] Fix | Delete

* Returns the proper URL for posts page.

[306] Fix | Delete

[307] Fix | Delete

* @return string The proper URL.

[308] Fix | Delete

[309] Fix | Delete

public function page_for_posts_url() {

[310] Fix | Delete

return \get_permalink( \get_option( 'page_for_posts' ) );

[311] Fix | Delete

}

[312] Fix | Delete

}

[313] Fix | Delete

[314] Fix | Delete