Changeset 32293

Timestamp:

04/24/2015 04:37:12 PM (9 years ago)

Author:

boonebgorges

Message:

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 #25143.

Location:

trunk

Files:

• src/wp-includes/rewrite.php (modified) (3 diffs)
• tests/phpunit/tests/rewrite (added)
• tests/phpunit/tests/rewrite.php (modified) (1 diff)
• tests/phpunit/tests/rewrite/addRewriteEndpoint.php (added)

trunk/src/wp-includes/rewrite.php

@@ -244 +244 @@
  *
  * @since 2.1.0
+ * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
+ *
  * @see WP_Rewrite::add_endpoint()
  * @global object $wp_rewrite
  *
- * @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.
- */
-function add_rewrite_endpoint( $name, $places, $query_var = null ) {
+ * @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`.
+ */
+function add_rewrite_endpoint( $name, $places, $query_var = true ) {
     global $wp_rewrite;
     $wp_rewrite->add_endpoint( $name, $places, $query_var );
@@ -1960 +1963 @@
      * @since 2.1.0
      * @since 3.9.0 $query_var parameter added.
+     * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
      * @access public
      *
@@ -1965 +1969 @@
      * @uses WP::add_query_var()
      *
-     * @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.
-     */
-    public function add_endpoint( $name, $places, $query_var = null ) {
+     * @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`.
+     */
+    public function add_endpoint( $name, $places, $query_var = true ) {
         global $wp;
-        if ( null === $query_var ) {
+
+        // For backward compatibility, if `null` has explicitly been passed as `$query_var`, assume `true`.
+        if ( true === $query_var || null === func_get_arg( 2 ) ) {
             $query_var = $name;
         }
         $this->endpoints[] = array( $places, $name, $query_var );
-        $wp->add_query_var( $query_var );
+
+        if ( $query_var ) {
+            $wp->add_query_var( $query_var );
+        }
     }
 

trunk/tests/phpunit/tests/rewrite.php

@@ -122 +122 @@
         restore_current_blog();
     }
+
+    /**
+     * @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() );
+    }
 }