mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-02-25 00:52:55 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Posts, Post Types: Don't force trailing slash in get_pagenum_link().

Browse Source 
Previously, a trailing slash was appended to the link returned from `get_pagenum_link()`. If the permalink structure didn't contain a trailing slash, this link could fail.

This change removes trailing slashes and only appends one if the site is set for adding trailing slashes.

This adds a new test file for the accompanying tests, `tests/phpunit/tests/link/getPagenumLink.php`, and moves an existing test for `get_pagenum_link()` to the same file.

Props davemad-davenet, darkfate, Nazgul, scribu, nacin, obenland, chriscct7, jesin, matthewppelsheimer, audrasjb, petitphp, mukesh27, oglekler, mai21, webtechpooja, tejwanihemant, nicolefurlan, hellofromTonya, costdev.
Fixes #2877.

git-svn-id: https://develop.svn.wordpress.org/trunk@56939 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Colin Stewart 2023-10-16 00:05:28 +00:00
parent f5e171652f
commit 60cd149b6f
3 changed files with 211 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/wp-includes/link-template.php
View File

@ -2431,6 +2431,9 @@ function get_pagenum_link( $pagenum = 1, $escape = true ) {
$qs_regex = '|\?.*?$|';
preg_match( $qs_regex, $request, $qs_match );
$parts = array();
$parts[] = untrailingslashit( get_bloginfo( 'url' ) );
if ( ! empty( $qs_match[0] ) ) {
$query_string = $qs_match[0];
$request = preg_replace( $qs_regex, '', $request );
@ -2442,17 +2445,21 @@ function get_pagenum_link( $pagenum = 1, $escape = true ) {
$request = preg_replace( '|^' . preg_quote( $wp_rewrite->index, '|' ) . '|i', '', $request );
$request = ltrim( $request, '/' );
$base = trailingslashit( get_bloginfo( 'url' ) );
if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' !== $request ) ) {
$base .= $wp_rewrite->index . '/';
$parts[] = $wp_rewrite->index;
}
$parts[] = untrailingslashit( $request );
if ( $pagenum > 1 ) {
$request = ( ( ! empty( $request ) ) ? trailingslashit( $request ) : $request ) . user_trailingslashit( $wp_rewrite->pagination_base . '/' . $pagenum, 'paged' );
$parts[] = $wp_rewrite->pagination_base;
$parts[] = $pagenum;
}
$result = $base . $request . $query_string;
$result = user_trailingslashit( implode( '/', array_filter( $parts ) ), 'paged' );
if ( ! empty( $query_string ) ) {
$result .= $query_string;
}
}
/**

22
tests/phpunit/tests/link.php
View File

@ -4,28 +4,6 @@
*/
class Tests_Link extends WP_UnitTestCase {
public function get_pagenum_link_cb( $url ) {
return $url . '/WooHoo';
}
/**
* @ticket 8847
*/
public function test_get_pagenum_link_case_insensitivity() {
$old_req_uri = $_SERVER['REQUEST_URI'];
$this->set_permalink_structure( '/%year%/%monthnum%/%day%/%postname%/' );
add_filter( 'home_url', array( $this, 'get_pagenum_link_cb' ) );
$_SERVER['REQUEST_URI'] = '/woohoo';
$paged = get_pagenum_link( 2 );
remove_filter( 'home_url', array( $this, 'get_pagenum_link_cb' ) );
$this->assertSame( $paged, home_url( '/WooHoo/page/2/' ) );
$_SERVER['REQUEST_URI'] = $old_req_uri;
}
public function test_wp_get_shortlink() {
$post_id = self::factory()->post->create();
$post_id2 = self::factory()->post->create();

199
tests/phpunit/tests/link/getPagenumLink.php Normal file
View File

@ -0,0 +1,199 @@
<?php
/**
* @group link
* @covers ::get_pagenum_link
*/
class Tests_Link_GetPagenumLink extends WP_UnitTestCase {
/**
* The original value of `$_SERVER['REQUEST_URI']`.
*
* @var string|null
*/
protected static $request_uri_original;
/**
* Backs up the value of `$_SERVER['REQUEST_URI']` before any tests run.
*/
public static function set_up_before_class() {
parent::set_up_before_class();
if ( isset( $_SERVER['REQUEST_URI'] ) ) {
self::$request_uri_original = $_SERVER['REQUEST_URI'];
}
}
/**
* Restores the value of `$_SERVER['REQUEST_URI']` after each test runs.
*/
public function tear_down() {
if ( null === self::$request_uri_original ) {
unset( $_SERVER['REQUEST_URI'] );
} else {
$_SERVER['REQUEST_URI'] = self::$request_uri_original;
}
parent::tear_down();
}
/**
* @ticket 8847
*/
public function test_get_pagenum_link_case_insensitivity() {
$this->set_permalink_structure( '/%year%/%monthnum%/%day%/%postname%/' );
add_filter( 'home_url', array( $this, 'get_pagenum_link_cb' ) );
$_SERVER['REQUEST_URI'] = '/woohoo';
$paged = get_pagenum_link( 2 );
remove_filter( 'home_url', array( $this, 'get_pagenum_link_cb' ) );
$this->assertSame( $paged, home_url( '/WooHoo/page/2/' ) );
}
/**
* Appends '/WooHoo' to the provided URL.
*
* Callback for the 'home_url' filter hook.
*
* @param string $url The base URL.
* @return string The base URL with '/WooHoo' appended.
*/
public function get_pagenum_link_cb( $url ) {
return $url . '/WooHoo';
}
/**
* Tests that a trailing slash is not added to the link.
*
* @ticket 2877
*
* @dataProvider data_get_pagenum_link_plain_permalinks
* @dataProvider data_get_pagenum_link
*
* @param string $permalink_structure The structure to use for permalinks.
* @param string $request_uri The value for `$_SERVER['REQUEST_URI']`.
* @param int $pagenum The page number to get the link for.
* @param string $expected The expected relative URL.
*/
public function test_get_pagenum_link_should_not_add_trailing_slash( $permalink_structure, $request_uri, $pagenum, $expected ) {
$this->set_permalink_structure( $permalink_structure );
$_SERVER['REQUEST_URI'] = $request_uri;
$paged = get_pagenum_link( $pagenum );
$this->assertSame( home_url( $expected ), $paged );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_get_pagenum_link_plain_permalinks() {
return array(
'page 1 and plain permalinks' => array(
'permalink_structure' => '',
'request_uri' => '/?paged=2',
'pagenum' => 1,
'expected' => '/',
),
'page 2 and plain permalinks' => array(
'permalink_structure' => '',
'request_uri' => '/',
'pagenum' => 2,
'expected' => '/?paged=2',
),
);
}
/**
* Tests that a trailing slash is added to the link when a trailing slash
* exists in the permalink structure.
*
* @ticket 2877
*
* @dataProvider data_get_pagenum_link
*
* @param string $permalink_structure The structure to use for permalinks.
* @param string $request_uri The value for `$_SERVER['REQUEST_URI']`.
* @param int $pagenum The page number to get the link for.
* @param string $expected The expected relative URL.
*/
public function test_get_pagenum_link_should_add_trailing_slash( $permalink_structure, $request_uri, $pagenum, $expected ) {
// Ensure the permalink structure has a trailing slash.
$permalink_structure = trailingslashit( $permalink_structure );
// Ensure the expected value has a trailing slash at the appropriate position.
if ( str_contains( $expected, '?' ) ) {
// Contains query args.
$parts = explode( '?', $expected, 2 );
$expected = trailingslashit( $parts[0] ) . '?' . $parts[1];
} else {
$expected = trailingslashit( $expected );
}
$this->set_permalink_structure( $permalink_structure );
$_SERVER['REQUEST_URI'] = $request_uri;
$paged = get_pagenum_link( $pagenum );
$this->assertSame( home_url( $expected ), $paged );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_get_pagenum_link() {
return array(
'page 1 and index.php' => array(
'permalink_structure' => '/index.php/%year%/%monthnum%/%day%/%postname%',
'request_uri' => '/index.php/woohoo/page/2/',
'pagenum' => 1,
'expected' => '/index.php/woohoo',
),
'page 2 and index.php' => array(
'permalink_structure' => '/index.php/%year%/%monthnum%/%day%/%postname%',
'request_uri' => '/index.php/woohoo/page/2/',
'pagenum' => 2,
'expected' => '/index.php/woohoo/page/2',
),
'page 1 with date-based permalinks' => array(
'permalink_structure' => '/%year%/%monthnum%/%day%/%postname%',
'request_uri' => '/woohoo/page/2/',
'pagenum' => 1,
'expected' => '/woohoo',
),
'page 2 with date-based permalinks' => array(
'permalink_structure' => '/%year%/%monthnum%/%day%/%postname%',
'request_uri' => '/woohoo',
'pagenum' => 2,
'expected' => '/woohoo/page/2',
),
'page 1 with postname-based permalinks' => array(
'permalink_structure' => '/%postname%',
'request_uri' => '/woohoo/page/2',
'pagenum' => 1,
'expected' => '/woohoo',
),
'page 2 with postname-based permalinks' => array(
'permalink_structure' => '/%postname%',
'request_uri' => '/woohoo',
'pagenum' => 2,
'expected' => '/woohoo/page/2',
),
'page 1 with postname-based permalinks and query args' => array(
'permalink_structure' => '/%postname%',
'request_uri' => '/woohoo/page/2?test=1234',
'pagenum' => 1,
'expected' => '/woohoo?test=1234',
),
'page 2 with postname-based permalinks and query args' => array(
'permalink_structure' => '/%postname%',
'request_uri' => '/woohoo?test=1234',
'pagenum' => 2,
'expected' => '/woohoo/page/2?test=1234',
),
);
}
}