<!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>[32293] trunk: Allow rewrite endpoints to be registered without also registering query vars.</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 { 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/32293">32293</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/32293","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-04-24 16:37:12 +0000 (Fri, 24 Apr 2015)</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'>Allow rewrite endpoints to be registered without also registering query vars.
Passing `false` to `add_rewrite_endpoint()` will now allow you to take
advantage of the rewrite API without thereby modifying the way that WP sets up
the main query from the request URI.
This new functionality allows developers to work around certain edge-case bugs,
such as when a proper endpoint request (such as `/test/1/`) would short-
circuit `is_home()` calculation when a static front page is set.
Props mordauk, boonebgorges.
Fixes <a href="https://core.trac.wordpress.org/ticket/25143">#25143</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrewritephp">trunk/src/wp-includes/rewrite.php</a></li>
<li><a href="#trunktestsphpunittestsrewritephp">trunk/tests/phpunit/tests/rewrite.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/tests/rewrite/</li>
<li><a href="#trunktestsphpunittestsrewriteaddRewriteEndpointphp">trunk/tests/phpunit/tests/rewrite/addRewriteEndpoint.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrewritephp"></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/rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rewrite.php 2015-04-24 14:56:37 UTC (rev 32292)
+++ trunk/src/wp-includes/rewrite.php 2015-04-24 16:37:12 UTC (rev 32293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -243,14 +243,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * activated and deactivated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Rewrite::add_endpoint()
</span><span class="cx" style="display: block; padding: 0 10px"> * @global object $wp_rewrite
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $name Name of the endpoint.
- * @param int $places Endpoint mask describing the places the endpoint should be added.
- * @param string $query_var Name of the corresponding query variable. Defaults to $name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $name Name of the endpoint.
+ * @param int $places Endpoint mask describing the places the endpoint should be added.
+ * @param string|bool $query_var Name of the corresponding query variable. Pass `false` to skip registering a query_var
+ * for this endpoint. Defaults to the value of `$name`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function add_rewrite_endpoint( $name, $places, $query_var = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function add_rewrite_endpoint( $name, $places, $query_var = true ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_rewrite;
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_rewrite->add_endpoint( $name, $places, $query_var );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1959,22 +1962,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.9.0 $query_var parameter added.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see add_rewrite_endpoint() for full documentation.
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses WP::add_query_var()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $name Name of the endpoint.
- * @param int $places Endpoint mask describing the places the endpoint should be added.
- * @param string $query_var Name of the corresponding query variable. Default is value of $name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $name Name of the endpoint.
+ * @param int $places Endpoint mask describing the places the endpoint should be added.
+ * @param string|bool $query_var Name of the corresponding query variable. Pass `false` to skip registering
+ * a query_var for this endpoint. Defaults to the value of `$name`.
</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 add_endpoint( $name, $places, $query_var = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function add_endpoint( $name, $places, $query_var = true ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( null === $query_var ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // For backward compatibility, if `null` has explicitly been passed as `$query_var`, assume `true`.
+ if ( true === $query_var || null === func_get_arg( 2 ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $query_var = $name;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $this->endpoints[] = array( $places, $name, $query_var );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp->add_query_var( $query_var );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( $query_var ) {
+ $wp->add_query_var( $query_var );
+ }
</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="trunktestsphpunittestsrewriteaddRewriteEndpointphp"></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/rewrite/addRewriteEndpoint.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rewrite/addRewriteEndpoint.php (rev 0)
+++ trunk/tests/phpunit/tests/rewrite/addRewriteEndpoint.php 2015-04-24 16:37:12 UTC (rev 32293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,50 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group rewrite
+ */
+class Tests_Rewrite_AddRewriteEndpoint extends WP_UnitTestCase {
+ private $qvs;
+
+ public function setUp() {
+ parent::setUp();
+ $this->qvs = $GLOBALS['wp']->public_query_vars;
+ }
+
+ public function tearDown() {
+ $GLOBALS['wp']->public_query_vars = $this->qvs;
+ parent::tearDown();
+ }
+
+ public function test_should_register_query_using_name_param_by_default() {
+ add_rewrite_endpoint( 'foo', EP_ALL );
+ $this->assertContains( 'foo', $GLOBALS['wp']->public_query_vars );
+ }
+
+ public function test_should_register_query_using_name_param_if_null_is_passed_as_query_var() {
+ add_rewrite_endpoint( 'foo', EP_ALL, null );
+ $this->assertContains( 'foo', $GLOBALS['wp']->public_query_vars );
+ }
+
+ public function test_should_register_query_using_query_var_param_if_not_null() {
+ add_rewrite_endpoint( 'foo', EP_ALL, 'bar' );
+ $this->assertContains( 'bar', $GLOBALS['wp']->public_query_vars );
+ }
+
+ /**
+ * @ticket 25143
+ */
+ public function test_should_register_query_var_using_name_param_if_true_is_passed_as_query_var() {
+ add_rewrite_endpoint( 'foo', EP_ALL, true );
+ $this->assertContains( 'foo', $GLOBALS['wp']->public_query_vars );
+ }
+
+ /**
+ * @ticket 25143
+ */
+ public function test_should_not_register_query_var_if_query_var_param_is_false() {
+ $qvs = $GLOBALS['wp']->public_query_vars;
+ add_rewrite_endpoint( 'foo', EP_ALL, false );
+ $this->assertSame( $qvs, $GLOBALS['wp']->public_query_vars );
+ }
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestsrewritephp"></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/rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rewrite.php 2015-04-24 14:56:37 UTC (rev 32292)
+++ trunk/tests/phpunit/tests/rewrite.php 2015-04-24 16:37:12 UTC (rev 32293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -121,4 +121,22 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</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 25143
+ */
+ public function test_is_home_should_be_false_when_visiting_custom_endpoint_without_a_registered_query_var_and_page_on_front_is_set() {
+
+ $page_id = $this->factory->post->create( array( 'post_type' => 'page' ) );
+ update_option( 'show_on_front', 'page' );
+ update_option( 'page_on_front', $page_id );
+
+ add_rewrite_endpoint( 'test', EP_ALL, false );
+ flush_rewrite_rules();
+
+ $this->go_to( home_url( '/test/1' ) );
+
+ $this->assertQueryTrue( 'is_front_page', 'is_page', 'is_singular' );
+ $this->assertFalse( is_home() );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>