<!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>[59228] trunk: Sitemaps: Improve `sitemap.xml` redirects when using custom permalinks.</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/59228">59228</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/59228","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-10-14 08:47:34 +0000 (Mon, 14 Oct 2024)</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'>Sitemaps: Improve `sitemap.xml` redirects when using custom permalinks.
Changes the way redirects from `sitemap.xml` to `wp-sitemap.xml` happen, so that they also work when using a more complex custom rewrite structure.
Props gmariani405, swissspidy, euthelup, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/61931">#61931</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswprewritephp">trunk/src/wp-includes/class-wp-rewrite.php</a></li>
<li><a href="#trunksrcwpincludessitemapsclasswpsitemapsphp">trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php</a></li>
<li><a href="#trunktestsphpunittestscanonicalsitemapsphp">trunk/tests/phpunit/tests/canonical/sitemaps.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswprewritephp"></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/class-wp-rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-rewrite.php 2024-10-14 01:05:09 UTC (rev 59227)
+++ trunk/src/wp-includes/class-wp-rewrite.php 2024-10-14 08:47:34 UTC (rev 59228)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1287,6 +1287,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // favicon.ico -- only if installed at the root.
</span><span class="cx" style="display: block; padding: 0 10px"> $favicon_rewrite = ( empty( $home_path['path'] ) || '/' === $home_path['path'] ) ? array( 'favicon\.ico$' => $this->index . '?favicon=1' ) : array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // sitemap.xml -- only if installed at the root.
+ $sitemap_rewrite = ( empty( $home_path['path'] ) || '/' === $home_path['path'] ) ? array( 'sitemap\.xml' => $this->index . '??sitemap=index' ) : array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Old feed and service files.
</span><span class="cx" style="display: block; padding: 0 10px"> $deprecated_files = array(
</span><span class="cx" style="display: block; padding: 0 10px"> '.*wp-(atom|rdf|rss|rss2|feed|commentsrss2)\.php$' => $this->index . '?feed=old',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1449,9 +1452,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Put them together.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->use_verbose_page_rules ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->rules = array_merge( $this->extra_rules_top, $robots_rewrite, $favicon_rewrite, $deprecated_files, $registration_pages, $root_rewrite, $comments_rewrite, $search_rewrite, $author_rewrite, $date_rewrite, $page_rewrite, $post_rewrite, $this->extra_rules );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->rules = array_merge( $this->extra_rules_top, $robots_rewrite, $favicon_rewrite, $sitemap_rewrite, $deprecated_files, $registration_pages, $root_rewrite, $comments_rewrite, $search_rewrite, $author_rewrite, $date_rewrite, $page_rewrite, $post_rewrite, $this->extra_rules );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->rules = array_merge( $this->extra_rules_top, $robots_rewrite, $favicon_rewrite, $deprecated_files, $registration_pages, $root_rewrite, $comments_rewrite, $search_rewrite, $author_rewrite, $date_rewrite, $post_rewrite, $page_rewrite, $this->extra_rules );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->rules = array_merge( $this->extra_rules_top, $robots_rewrite, $favicon_rewrite, $sitemap_rewrite, $deprecated_files, $registration_pages, $root_rewrite, $comments_rewrite, $search_rewrite, $author_rewrite, $date_rewrite, $post_rewrite, $page_rewrite, $this->extra_rules );
</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="trunksrcwpincludessitemapsclasswpsitemapsphp"></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/sitemaps/class-wp-sitemaps.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php 2024-10-14 01:05:09 UTC (rev 59227)
+++ trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php 2024-10-14 08:47:34 UTC (rev 59228)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,7 +75,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->register_sitemaps();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add additional action callbacks.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'pre_handle_404', array( $this, 'redirect_sitemapxml' ), 10, 2 );
</del><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'robots_txt', array( $this, 'add_robots' ), 0, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -223,6 +222,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Redirects a URL to the wp-sitemap.xml
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 6.7.0 Deprecated in favor of {@see WP_Rewrite::rewrite_rules()}
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $bypass Pass-through of the pre_handle_404 filter value.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Query $query The WP_Query object.
</span></span></pre></div>
<a id="trunktestsphpunittestscanonicalsitemapsphp"></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/canonical/sitemaps.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/canonical/sitemaps.php 2024-10-14 01:05:09 UTC (rev 59227)
+++ trunk/tests/phpunit/tests/canonical/sitemaps.php 2024-10-14 08:47:34 UTC (rev 59228)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,6 +52,17 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Ensure sitemaps redirects work as expected with a more custom rewrite structure.
+ *
+ * @dataProvider data_sitemaps_canonical_pretty_redirects
+ * @ticket 61931
+ */
+ public function test_sitemaps_canonical_custom_pretty_redirects( $test_url, $expected ) {
+ $this->set_permalink_structure( '/%category%/%year%/%monthnum%/%postname%/' );
+ $this->assertCanonical( $test_url, $expected, 61931 );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Data provider for test_sitemaps_canonical_pretty_redirects.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array[] {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,8 +72,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $1 The expected canonical URL.
</span><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">- public function data_sitemaps_canonical_pretty_redirects() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function data_sitemaps_canonical_pretty_redirects() {
</ins><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // sitemap.xml special case.
+ array( '/sitemap.xml', '/wp-sitemap.xml' ),
+ array( '/sitemap.xml/', '/wp-sitemap.xml' ),
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Ugly/incorrect versions redirect correctly.
</span><span class="cx" style="display: block; padding: 0 10px"> array( '/?sitemap=index', '/wp-sitemap.xml' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '/wp-sitemap.xml/', '/wp-sitemap.xml' ),
</span></span></pre>
</div>
</div>
</body>
</html>