In `paginate_links()`, improve handling of custom pagination query vars.

Custom pagination query vars, as provided in the 'base' parameter, must be
detected in the current page URL and removed before generating fresh pagination
links. The logic introduced in this changeset ensures that these custom
query vars are properly detected in cases where the 'format' param contains
a `#`.

This is a follow-up to [31203] #30831.

Fixes #31939.

git-svn-id: https://develop.svn.wordpress.org/trunk@32359 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Boone Gorges 2015-05-05 21:58:23 +00:00
parent 70f530e238
commit 35db6d722b
2 changed files with 33 additions and 4 deletions

View File

@ -2659,12 +2659,21 @@ function paginate_links( $args = '' ) {
// Merge additional query vars found in the original URL into 'add_args' array.
if ( isset( $url_parts[1] ) ) {
// Find the format argument.
$format_query = parse_url( str_replace( '%_%', $args['format'], $args['base'] ), PHP_URL_QUERY );
wp_parse_str( $format_query, $format_arg );
$format = explode( '?', str_replace( '%_%', $args['format'], $args['base'] ) );
$format_query = isset( $format[1] ) ? $format[1] : '';
wp_parse_str( $format_query, $format_args );
// Find the query args of the requested URL.
wp_parse_str( $url_parts[1], $url_query_args );
// Remove the format argument from the array of query arguments, to avoid overwriting custom format.
wp_parse_str( remove_query_arg( array_keys( $format_arg ), $url_parts[1] ), $query_args );
$args['add_args'] = array_merge( $args['add_args'], urlencode_deep( $query_args ) );
foreach ( $format_args as $format_arg => $format_arg_value ) {
if ( isset( $url_query_args[ $format_arg ] ) ) {
unset( $url_query_args[ $format_arg ] );
}
}
$args['add_args'] = array_merge( $args['add_args'], urlencode_deep( $url_query_args ) );
}
// Who knows what else people pass in $args

View File

@ -311,4 +311,24 @@ EXPECTED;
$this->assertContains( "<span class='page-numbers current'>3</span>", $links );
}
/**
* @ticket 31939
*/
public function test_custom_base_query_arg_should_be_stripped_from_current_url_before_generating_pag_links() {
// Fake the current URL: example.com?foo
$request_uri = $_SERVER['REQUEST_URI'];
$_SERVER['REQUEST_URI'] = add_query_arg( 'foo', '', $request_uri );
$links = paginate_links( array(
'base' => add_query_arg( 'foo', '%_%', home_url() ),
'format' => '%#%',
'total' => 5,
'current' => 1,
'type' => 'array',
) );
$page_2_url = home_url() . '?foo=2';
$this->assertContains( "<a class='page-numbers' href='$page_2_url'>2</a>", $links );
}
}