<!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>[47878] trunk: Canonical: Add the ability to disable `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/47878">47878</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/47878","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-01 18:47:41 +0000 (Mon, 01 Jun 2020)</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: Add the ability to disable `redirect_guess_404_permalink()`.
This also adds a few more filters to make adding redirects easier. Notably:
1. `do_redirect_guess_404_permalink`
2. `pre_redirect_guess_404_permalink`
3. `strict_redirect_guess_404_permalink`
Fixes: <a href="https://core.trac.wordpress.org/ticket/16557">#16557</a>.
Props: msafi, nacin, simonwheatley, westi, mboynes, joostdevalk, Lex_Robinson, MikeSchinkel, haukep, paulschreiber, DrewAPicture, ravenswd, esemlabel, stevegibson12, martychc23, DrLightman, jivanpal, neonkowy, laternastudio, apedog, audrasjb, davidbaumwald, Confridin, donmhico, ryotsun. </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 2020-06-01 16:37:03 UTC (rev 47877)
+++ trunk/src/wp-includes/canonical.php 2020-06-01 18:47:41 UTC (rev 47878)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -835,9 +835,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function redirect_guess_404_permalink() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether to do redirect guess of 404 requests.
+ *
+ * Returning a false value from the filter will disable redirect guess 404 permalink.
+ * and return early.
+ *
+ * @since 5.5.0
+ *
+ * @param bool $do_redirect_guess Whether to do redirect guess 404 permalink. Default true.
+ */
+ if ( false === apply_filters( 'do_redirect_guess_404_permalink', true ) ) {
+ return false;
+ }
+
+ /**
+ * Filters whether to short-circuit redirect guess of 404 requests.
+ *
+ * Return a non-false value from the filter will short-circuit the handling and return early.
+ *
+ * @since 5.5.0
+ *
+ * @param bool $pre Whether to short-circuit redirect guess 404 permalink. Default null.
+ */
+ $pre = apply_filters( 'pre_redirect_guess_404_permalink', null );
+ if ( null !== $pre ) {
+ return $pre;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( get_query_var( 'name' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $where = $wpdb->prepare( 'post_name LIKE %s', $wpdb->esc_like( get_query_var( 'name' ) ) . '%' );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether to do a strict or loose guess.
+ *
+ * Returning true value from the filter will guess redirect only exact post_name matches.
+ *
+ * @since 5.5.0
+ *
+ * @param bool $strict_guess Whether to do a strict/exact guess. Default false.
+ */
+ $strict_guess = apply_filters( 'strict_redirect_guess_404_permalink', false );
+
+ if ( $strict_guess ) {
+ $where = $wpdb->prepare( 'post_name = %s', get_query_var( 'name' ) );
+ } else {
+ $where = $wpdb->prepare( 'post_name LIKE %s', $wpdb->esc_like( get_query_var( 'name' ) ) . '%' );
+ }
+
</ins><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"> $where .= $wpdb->prepare( ' AND post_type = %s', get_query_var( 'post_type' ) );
</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 2020-06-01 16:37:03 UTC (rev 47877)
+++ trunk/tests/phpunit/tests/canonical.php 2020-06-01 18:47:41 UTC (rev 47878)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -231,6 +231,51 @@
</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">+ * @ticket 16557
+ */
+ public function test_do_redirect_guess_404_permalink() {
+ // Test disable do_redirect_guess_404_permalink().
+ add_filter( 'do_redirect_guess_404_permalink', '__return_false' );
+ $this->go_to( '/child-page-1' );
+ $this->assertFalse( redirect_guess_404_permalink() );
+ }
+
+ /**
+ * @ticket 16557
+ */
+ public function test_pre_redirect_guess_404_permalink() {
+ // Test short-circuit filter.
+ add_filter(
+ 'pre_redirect_guess_404_permalink',
+ function() {
+ return 'wp';
+ }
+ );
+ $this->go_to( '/child-page-1' );
+ $this->assertEquals( 'wp', redirect_guess_404_permalink() );
+ }
+
+ /**
+ * @ticket 16557
+ */
+ public function test_strict_redirect_guess_404_permalink() {
+ $post = self::factory()->post->create(
+ array(
+ 'post_title' => 'strict-redirect-guess-404-permalink',
+ )
+ );
+
+ $this->go_to( 'strict-redirect' );
+
+ // Test default 'non-strict' redirect guess.
+ $this->assertEquals( get_permalink( $post ), redirect_guess_404_permalink() );
+
+ // Test 'strict' redirect guess.
+ add_filter( 'strict_redirect_guess_404_permalink', '__return_true' );
+ $this->assertFalse( redirect_guess_404_permalink() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 43745
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_utf8_query_keys_canonical() {
</span></span></pre>
</div>
</div>
</body>
</html>