<!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>[57645] trunk: Canonical: Limit post types searched by `redirect_guess_404_permalink()`.</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/57645">57645</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/57645","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-02-16 23:32:48 +0000 (Fri, 16 Feb 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'>Canonical: Limit post types searched by `redirect_guess_404_permalink()`.
Limit the post types searched in `redirect_guess_404_permalink()` to public, searchable post types. This prevents redirects to 404 pages and the exposure of private post type slugs.
Props francescocarlucci, peterwilsoncc, rajinsharwar.
Fixes <a href="https://core.trac.wordpress.org/ticket/59795">#59795</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescanonicalphp">trunk/src/wp-includes/canonical.php</a></li>
<li><a href="#trunktestsphpunittestscanonicalphp">trunk/tests/phpunit/tests/canonical.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescanonicalphp"></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/canonical.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/canonical.php 2024-02-16 21:45:18 UTC (rev 57644)
+++ trunk/src/wp-includes/canonical.php 2024-02-16 23:32:48 UTC (rev 57645)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -949,6 +949,9 @@
</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"> if ( get_query_var( 'name' ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $publicly_viewable_statuses = array_filter( get_post_stati(), 'is_post_status_viewable' );
+ $publicly_viewable_post_types = array_filter( get_post_types( array( 'exclude_from_search' => false ) ), 'is_post_type_viewable' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether to perform a strict guess for a 404 redirect.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -969,12 +972,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // If any of post_type, year, monthnum, or day are set, use them to refine the query.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( get_query_var( 'post_type' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( get_query_var( 'post_type' ) ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_types = array_intersect( get_query_var( 'post_type' ), $publicly_viewable_post_types );
+ if ( empty( $post_types ) ) {
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $where .= " AND post_type IN ('" . join( "', '", esc_sql( get_query_var( 'post_type' ) ) ) . "')";
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! in_array( get_query_var( 'post_type' ), $publicly_viewable_post_types, true ) ) {
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $where .= $wpdb->prepare( ' AND post_type = %s', get_query_var( 'post_type' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $where .= " AND post_type IN ('" . implode( "', '", get_post_types( array( 'public' => true ) ) ) . "')";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $where .= " AND post_type IN ('" . implode( "', '", esc_sql( $publicly_viewable_post_types ) ) . "')";
</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"> if ( get_query_var( 'year' ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -987,7 +997,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $where .= $wpdb->prepare( ' AND DAYOFMONTH(post_date) = %d', get_query_var( 'day' ) );
</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">- $publicly_viewable_statuses = array_filter( get_post_stati(), 'is_post_status_viewable' );
</del><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = $wpdb->get_var( "SELECT ID FROM $wpdb->posts WHERE $where AND post_status IN ('" . implode( "', '", esc_sql( $publicly_viewable_statuses ) ) . "')" );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestscanonicalphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/canonical.php 2024-02-16 21:45:18 UTC (rev 57644)
+++ trunk/tests/phpunit/tests/canonical.php 2024-02-16 23:32:48 UTC (rev 57645)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,14 +10,48 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Canonical extends WP_Canonical_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static $private_cpt_post;
+
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ // Set up fixtures in WP_Canonical_UnitTestCase.
+ parent::wpSetUpBeforeClass( $factory );
+
+ self::set_up_custom_post_types();
+ self::$private_cpt_post = $factory->post->create(
+ array(
+ 'post_type' => 'wp_tests_private',
+ 'post_title' => 'private-cpt-post',
+ )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function set_up() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::set_up();
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$author_id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::set_up_custom_post_types();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'wp_attachment_pages_enabled', 1 );
</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">+ * Register custom post type for tests.
+ *
+ * Register non publicly queryable post type with public set to true.
+ *
+ * These arguments are intentionally contradictory for the test associated
+ * with ticket #59795.
+ */
+ public static function set_up_custom_post_types() {
+ register_post_type(
+ 'wp_tests_private',
+ array(
+ 'public' => true,
+ 'publicly_queryable' => false,
+ )
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_canonical
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_canonical( $test_url, $expected, $ticket = 0, $expected_doing_it_wrong = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -343,20 +377,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Ensure multiple post types do not throw a notice.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 43056
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 59795
+ *
+ * @dataProvider data_redirect_guess_404_permalink_post_types
</ins><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 test_redirect_guess_404_permalink_post_types() {
- /*
- * Sample-page is intentionally missspelt as sample-pag to ensure
- * the 404 post permalink guessing runs.
- *
- * Please do not correct the apparent typo.
- */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_redirect_guess_404_permalink_post_types( $original_url, $expected ) {
+ $this->assertCanonical( $original_url, $expected );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // String format post type.
- $this->assertCanonical( '/?name=sample-pag&post_type=page', '/sample-page/' );
- // Array formatted post type or types.
- $this->assertCanonical( '/?name=sample-pag&post_type[]=page', '/sample-page/' );
- $this->assertCanonical( '/?name=sample-pag&post_type[]=page&post_type[]=post', '/sample-page/' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Data provider for test_redirect_guess_404_permalink_post_types().
+ *
+ * In the original URLs the post names are intentionally misspelled
+ * to test the redirection.
+ *
+ * Please do not correct the apparent typos.
+ *
+ * @return array[]
+ */
+ public function data_redirect_guess_404_permalink_post_types() {
+ return array(
+ 'single string formatted post type' => array(
+ 'original_url' => '/?name=sample-pag&post_type=page',
+ 'expected' => '/sample-page/',
+ ),
+ 'single array formatted post type' => array(
+ 'original_url' => '/?name=sample-pag&post_type[]=page',
+ 'expected' => '/sample-page/',
+ ),
+ 'multiple array formatted post type' => array(
+ 'original_url' => '/?name=sample-pag&post_type[]=page&post_type[]=post',
+ 'expected' => '/sample-page/',
+ ),
+ 'do not redirect to private post type' => array(
+ 'original_url' => '/?name=private-cpt-po&post_type[]=wp_tests_private',
+ 'expected' => '/?name=private-cpt-po&post_type[]=wp_tests_private',
+ ),
+ );
</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>
</div>
</body>
</html>