Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Helpers;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Wrappers\WP_Query_Wrapper;

[4] Fix | Delete

use Yoast\WP\SEO\Wrappers\WP_Rewrite_Wrapper;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* A helper object for pagination.

[8] Fix | Delete

[9] Fix | Delete

* Used for the canonical URL and the rel "next" and "prev" meta tags.

[10] Fix | Delete

[11] Fix | Delete

class Pagination_Helper {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Holds the WP rewrite wrapper instance.

[15] Fix | Delete

[16] Fix | Delete

* @var WP_Rewrite_Wrapper WP_Rewrite wrapper.

[17] Fix | Delete

[18] Fix | Delete

protected $wp_rewrite_wrapper;

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Holds the WP query wrapper instance.

[22] Fix | Delete

[23] Fix | Delete

* @var WP_Query_Wrapper WP_Query wrapper.

[24] Fix | Delete

[25] Fix | Delete

protected $wp_query_wrapper;

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Pagination_Helper constructor.

[29] Fix | Delete

[30] Fix | Delete

* @param WP_Rewrite_Wrapper $wp_rewrite_wrapper The rewrite wrapper.

[31] Fix | Delete

* @param WP_Query_Wrapper $wp_query_wrapper The query wrapper.

[32] Fix | Delete

[33] Fix | Delete

public function __construct(

[34] Fix | Delete

WP_Rewrite_Wrapper $wp_rewrite_wrapper,

[35] Fix | Delete

WP_Query_Wrapper $wp_query_wrapper

[36] Fix | Delete

) {

[37] Fix | Delete

$this->wp_rewrite_wrapper = $wp_rewrite_wrapper;

[38] Fix | Delete

$this->wp_query_wrapper = $wp_query_wrapper;

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Checks whether adjacent rel links are disabled.

[43] Fix | Delete

[44] Fix | Delete

* @return bool Whether adjacent rel links are disabled or not.

[45] Fix | Delete

[46] Fix | Delete

public function is_rel_adjacent_disabled() {

[47] Fix | Delete

/**

[48] Fix | Delete

* Filter: 'wpseo_disable_adjacent_rel_links' - Allows disabling of Yoast adjacent links if this is being handled by other code.

[49] Fix | Delete

[50] Fix | Delete

* @param bool $links_generated Indicates if other code has handled adjacent links.

[51] Fix | Delete

[52] Fix | Delete

return \apply_filters( 'wpseo_disable_adjacent_rel_links', false );

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Builds a paginated URL.

[57] Fix | Delete

[58] Fix | Delete

* @param string $url The un-paginated URL of the current archive.

[59] Fix | Delete

* @param string $page The page number to add on to $url for the $link tag.

[60] Fix | Delete

* @param bool $add_pagination_base Optional. Whether to add the pagination base (`page`) to the url.

[61] Fix | Delete

* @param string $pagination_query_name Optional. The name of the query argument that holds the current page.

[62] Fix | Delete

[63] Fix | Delete

* @return string The paginated URL.

[64] Fix | Delete

[65] Fix | Delete

public function get_paginated_url( $url, $page, $add_pagination_base = true, $pagination_query_name = 'page' ) {

[66] Fix | Delete

$wp_rewrite = $this->wp_rewrite_wrapper->get();

[67] Fix | Delete

[68] Fix | Delete

$key_query_loop = $this->get_key_query_loop();

[69] Fix | Delete

if ( $key_query_loop ) {

[70] Fix | Delete

$pagination_query_name = $key_query_loop;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

if ( $wp_rewrite->using_permalinks() && ! $key_query_loop ) {

[74] Fix | Delete

$url_parts = \wp_parse_url( $url );

[75] Fix | Delete

$has_url_params = \array_key_exists( 'query', $url_parts );

[76] Fix | Delete

[77] Fix | Delete

if ( $has_url_params ) {

[78] Fix | Delete

// We need to first remove the query params, before potentially adding the pagination parts.

[79] Fix | Delete

\wp_parse_str( $url_parts['query'], $query_parts );

[80] Fix | Delete

[81] Fix | Delete

$url = \trailingslashit( \remove_query_arg( \array_keys( $query_parts ), $url ) );

[82] Fix | Delete

[83] Fix | Delete

if ( $add_pagination_base ) {

[84] Fix | Delete

$url .= \trailingslashit( $wp_rewrite->pagination_base );

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

// We can now re-add the query params, after appending the last pagination parts.

[88] Fix | Delete

return \add_query_arg( $query_parts, \user_trailingslashit( $url . $page ) );

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

$url = \trailingslashit( $url );

[92] Fix | Delete

if ( $add_pagination_base ) {

[93] Fix | Delete

$url .= \trailingslashit( $wp_rewrite->pagination_base );

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

return \user_trailingslashit( $url . $page );

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

return \add_query_arg( $pagination_query_name, $page, \user_trailingslashit( $url ) );

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Gets the number of archive pages.

[104] Fix | Delete

[105] Fix | Delete

* @return int The number of archive pages.

[106] Fix | Delete

[107] Fix | Delete

public function get_number_of_archive_pages() {

[108] Fix | Delete

$wp_query = $this->wp_query_wrapper->get_query();

[109] Fix | Delete

[110] Fix | Delete

return (int) $wp_query->max_num_pages;

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Returns the current page for paged archives.

[115] Fix | Delete

[116] Fix | Delete

* @return int The current archive page.

[117] Fix | Delete

[118] Fix | Delete

public function get_current_archive_page_number() {

[119] Fix | Delete

$wp_query = $this->wp_query_wrapper->get_main_query();

[120] Fix | Delete

$page_number = (int) $wp_query->get( 'paged' );

[121] Fix | Delete

if ( $page_number > 1 ) {

[122] Fix | Delete

return $page_number;

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

$query_loop_page_number = $this->get_page_number_from_query_loop();

[126] Fix | Delete

[127] Fix | Delete

if ( $query_loop_page_number ) {

[128] Fix | Delete

return $query_loop_page_number;

[129] Fix | Delete

}

[130] Fix | Delete

return 0;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

/**

[134] Fix | Delete

* Returns the current page for paged post types.

[135] Fix | Delete

[136] Fix | Delete

* @return int The current post page.

[137] Fix | Delete

[138] Fix | Delete

public function get_current_post_page_number() {

[139] Fix | Delete

$wp_query = $this->wp_query_wrapper->get_main_query();

[140] Fix | Delete

[141] Fix | Delete

$query_loop_page_number = $this->get_page_number_from_query_loop();

[142] Fix | Delete

[143] Fix | Delete

if ( $query_loop_page_number ) {

[144] Fix | Delete

return $query_loop_page_number;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

return (int) $wp_query->get( 'page' );

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Returns the current page number.

[152] Fix | Delete

[153] Fix | Delete

* @return int The current page number.

[154] Fix | Delete

[155] Fix | Delete

public function get_current_page_number() {

[156] Fix | Delete

// Get the page number for an archive page.

[157] Fix | Delete

$page_number = \get_query_var( 'paged', 1 );

[158] Fix | Delete

if ( $page_number > 1 ) {

[159] Fix | Delete

return $page_number;

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

$query_loop_page_number = $this->get_page_number_from_query_loop();

[163] Fix | Delete

[164] Fix | Delete

if ( $query_loop_page_number ) {

[165] Fix | Delete

return $query_loop_page_number;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

// Get the page number for a page in a paginated post.

[169] Fix | Delete

return \get_query_var( 'page', 1 );

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

/**

[173] Fix | Delete

* Returns the key of the query loop.

[174] Fix | Delete

[175] Fix | Delete

* @return string The key of the query loop.

[176] Fix | Delete

[177] Fix | Delete

public function get_key_query_loop() {

[178] Fix | Delete

$regex_pattern = '/^query-\d+-page$/';

[179] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- not form data.

[180] Fix | Delete

foreach ( $_GET as $key => $value ) {

[181] Fix | Delete

if ( \preg_match( $regex_pattern, $key ) ) {

[182] Fix | Delete

return $key;

[183] Fix | Delete

}

[184] Fix | Delete

}

[185] Fix | Delete

return '';

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Returns the page number from the query loop.

[190] Fix | Delete

[191] Fix | Delete

* @return string The page number from the query loop.

[192] Fix | Delete

[193] Fix | Delete

public function get_page_number_from_query_loop() {

[194] Fix | Delete

$key_query_loop = $this->get_key_query_loop();

[195] Fix | Delete

[196] Fix | Delete

if ( $key_query_loop ) {

[197] Fix | Delete

// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated,WordPress.Security.NonceVerification.Recommended -- Validated in get_key_query_loop().

[198] Fix | Delete

$page_number = (int) $_GET[ $key_query_loop ];

[199] Fix | Delete

if ( $page_number > 1 ) {

[200] Fix | Delete

return $page_number;

[201] Fix | Delete

}

[202] Fix | Delete

}

[203] Fix | Delete

return '';

[204] Fix | Delete

}

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete