Changeset 52815

Timestamp:

03/02/2022 03:38:27 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add a @since note for WP::parse_request() about the new return value.

Includes minor code layout fixes for consistency. Additionally, this moves a more general unit test above the more specific one.

Follow-up to [52814].

See #10886.

Location:

trunk

Files:

• src/wp-includes/class-wp.php (modified) (3 diffs)
• tests/phpunit/tests/wp/parseRequest.php (modified) (2 diffs)

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

@@ -126 +126 @@
      *
      * @since 2.0.0
+     * @since 6.0.0 A return value was added.
      *
      * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
@@ -759 +760 @@
     public function main( $query_args = '' ) {
         $this->init();
+
         $parsed = $this->parse_request( $query_args );
+
         $this->send_headers();
+
         if ( $parsed ) {
             $this->query_posts();
@@ -766 +770 @@
             $this->register_globals();
         }
+
         /**
          * Fires once the WordPress environment has been set up.

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

@@ -17 +17 @@
 
     /**
-     * Test that PHP 8.1 "passing null to non-nullable" deprecation notice
+     * Tests the return value of the parse_request() method.
+     *
+     * @ticket 10886
+     */
+    public function test_parse_request_returns_bool() {
+        // Check that parse_request() returns true by default.
+        $this->assertTrue( $this->wp->parse_request() );
+
+        add_filter( 'do_parse_request', '__return_false' );
+
+        // Check that parse_request() returns false if the request was not parsed.
+        $this->assertFalse( $this->wp->parse_request() );
+    }
+
+    /**
+     * Tests that PHP 8.1 "passing null to non-nullable" deprecation notice
      * is not thrown when the home URL has no path/trailing slash (default setup).
      *
@@ -40 +55 @@
         $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' );
-
-    }
 }