<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56939] trunk: Posts, Post Types: Don't force trailing slash in `get_pagenum_link()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56939">56939</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56939","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>costdev</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-10-16 00:05:28 +0000 (Mon, 16 Oct 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Posts, Post Types: Don't force trailing slash in `get_pagenum_link()`.
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 <a href="https://core.trac.wordpress.org/ticket/2877">#2877</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
<li><a href="#trunktestsphpunittestslinkphp">trunk/tests/phpunit/tests/link.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestslinkgetPagenumLinkphp">trunk/tests/phpunit/tests/link/getPagenumLink.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeslinktemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/link-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/link-template.php 2023-10-15 14:53:12 UTC (rev 56938)
+++ trunk/src/wp-includes/link-template.php 2023-10-16 00:05:28 UTC (rev 56939)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2431,6 +2431,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $qs_regex = '|\?.*?$|';
</span><span class="cx" style="display: block; padding: 0 10px"> preg_match( $qs_regex, $request, $qs_match );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $parts = array();
+ $parts[] = untrailingslashit( get_bloginfo( 'url' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $qs_match[0] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $query_string = $qs_match[0];
</span><span class="cx" style="display: block; padding: 0 10px"> $request = preg_replace( $qs_regex, '', $request );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2442,17 +2445,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = preg_replace( '|^' . preg_quote( $wp_rewrite->index, '|' ) . '|i', '', $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $request = ltrim( $request, '/' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $base = trailingslashit( get_bloginfo( 'url' ) );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' !== $request ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $base .= $wp_rewrite->index . '/';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $parts[] = $wp_rewrite->index;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $parts[] = untrailingslashit( $request );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $pagenum > 1 ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $request = ( ( ! empty( $request ) ) ? trailingslashit( $request ) : $request ) . user_trailingslashit( $wp_rewrite->pagination_base . '/' . $pagenum, 'paged' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $parts[] = $wp_rewrite->pagination_base;
+ $parts[] = $pagenum;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = $base . $request . $query_string;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = user_trailingslashit( implode( '/', array_filter( $parts ) ), 'paged' );
+ if ( ! empty( $query_string ) ) {
+ $result .= $query_string;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestslinkgetPagenumLinkphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/link/getPagenumLink.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/link/getPagenumLink.php (rev 0)
+++ trunk/tests/phpunit/tests/link/getPagenumLink.php 2023-10-16 00:05:28 UTC (rev 56939)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,199 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?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',
+ ),
+ );
+ }
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestslinkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/link.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/link.php 2023-10-15 14:53:12 UTC (rev 56938)
+++ trunk/tests/phpunit/tests/link.php 2023-10-16 00:05:28 UTC (rev 56939)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,28 +4,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Link extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_get_shortlink() {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id2 = self::factory()->post->create();
</span></span></pre>
</div>
</div>
</body>
</html>