Changeset 46099

Timestamp:

09/12/2019 09:46:41 PM (6 years ago)

Author:

kadamwhite

Message:

REST API: Accept string path in rest_ensure_request.

Update rest_ensure_request() to accept a string path, permitting a string path to be passed to rest_do_request() as is indicated (previously inaccurately) in that method's PHPDoc.

Props TimothyBlynJacobs, kadamwhite.
Fixes #40614.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api.php (modified) (1 diff)

trunk/src/wp-includes/rest-api.php

@@ -483 +483 @@
  *
  * @since 4.4.0
- *
- * @param array|WP_REST_Request $request Request to check.
+ * @since 5.3.0 Accept string argument for the request path.
+ *
+ * @param array|string|WP_REST_Request $request Request to check.
  * @return WP_REST_Request REST request instance.
  */
@@ -490 +491 @@
     if ( $request instanceof WP_REST_Request ) {
         return $request;
+    }
+
+    if ( is_string( $request ) ) {
+        return new WP_REST_Request( 'GET', $request );
     }
 

trunk/tests/phpunit/tests/rest-api.php

@@ -745 +745 @@
         $GLOBALS['wp_rest_server'] = $rest_server;
     }
+
+    /**
+     * @ticket 40614
+     */
+    function test_rest_ensure_response_accepts_path_string() {
+        $request = rest_ensure_request( '/wp/v2/posts' );
+        $this->assertInstanceOf( 'WP_REST_Request', $request );
+        $this->assertEquals( '/wp/v2/posts', $request->get_route() );
+        $this->assertEquals( 'GET', $request->get_method() );
+    }
 }