Changeset 52814

Timestamp:

03/02/2022 03:10:48 PM (3 years ago)

Author:

spacedmonkey

Message:

Bootstrap/Load: Stop unnecessary queries when using the do_parse_request filter.

Developers of plugins and themes can use the do_parse_request filter to hot-wire requests and hook in early to render custom pages. However, even through these request may not need post queries and 404 lookups to be run, they run anyway. This can results in unnecessary SQL queries running on these requests. By adding a return value to the parse_request method of the WP class, these queries can now be skipped.

Props junsuijin, ryan, westi, sivel, dd32, wonderboymusic, arnee, tyxla, DrewAPicture, lukecavanagh, SergeyBiryukov, davidbaumwald, Spacedmonkey, pbearne.
Fixes #10886.

Location:

trunk

Files:

• src/wp-includes/class-wp.php (modified) (4 diffs)
• tests/phpunit/tests/wp/parseRequest.php (modified) (1 diff)

trunk/src/wp-includes/class-wp.php

@@ -130 +130 @@
      *
      * @param array|string $extra_query_vars Set the extra query variables.
+     * @return bool Whether the request was parsed.
      */
     public function parse_request( $extra_query_vars = '' ) {
@@ -144 +145 @@
          */
         if ( ! apply_filters( 'do_parse_request', true, $this, $extra_query_vars ) ) {
-            return;
+            return false;
         }
 
@@ -395 +396 @@
          */
         do_action_ref_array( 'parse_request', array( &$this ) );
+
+        return true;
     }
 
@@ -756 +759 @@
     public function main( $query_args = '' ) {
         $this->init();
-        $this->parse_request( $query_args );
+        $parsed = $this->parse_request( $query_args );
         $this->send_headers();
-        $this->query_posts();
-        $this->handle_404();
-        $this->register_globals();
-
+        if ( $parsed ) {
+            $this->query_posts();
+            $this->handle_404();
+            $this->register_globals();
+        }
         /**
          * Fires once the WordPress environment has been set up.

trunk/tests/phpunit/tests/wp/parseRequest.php

@@ -40 +40 @@
         $this->assertSame( '', $this->wp->request );
     }
+    /**
+     * Test that the parse_request() returns bool
+     *
+     * @ticket 10886
+     */
+    public function test_parse_request_returns_bool() {
+
+        // check if parse_request() returns true for default setup.
+        $this->assertTrue( $this->wp->parse_request(), 'returns true' );
+
+        // add filter to shortcut the parse_request function.
+        add_filter( 'do_parse_request', '__return_false' );
+        $this->assertFalse( $this->wp->parse_request(), 'returns false' );
+        remove_filter( 'do_parse_request', '__return_false' );
+
+    }
 }