Changeset 53217

Timestamp:

04/19/2022 02:38:16 PM (2 years ago)

Author:

gziolo

Message:

REST API: Respect _fields query arg in preloaded requests

Ensures that preloaded request can include a _fields query param that asks that only selected response fields are returned.

Props jsnajdr, timothyblynjacobs.
Fixes #55213.
See #55567.

Location:

trunk

Files:

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

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

@@ -2869 +2869 @@
     if ( 200 === $response->status ) {
         $server = rest_get_server();
+        /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
+        $response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $server, $request );
         $embed  = $request->has_param( '_embed' ) ? rest_parse_embed_param( $request['_embed'] ) : false;
         $data   = (array) $server->response_to_data( $response, $embed );
 
         if ( 'OPTIONS' === $method ) {
-            $response = rest_send_allow_header( $response, $server, $request );
-
             $memo[ $method ][ $path ] = array(
                 'body'    => $data,

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

@@ -2491 +2491 @@
         );
     }
+
+    /**
+     * @ticket 55213
+     */
+    public function test_rest_preload_api_request_fields() {
+        $preload_paths = array(
+            '/',
+            '/?_fields=description',
+        );
+
+        $preload_data = array_reduce(
+            $preload_paths,
+            'rest_preload_api_request',
+            array()
+        );
+
+        $this->assertSame( array_keys( $preload_data ), array( '/', '/?_fields=description' ) );
+
+        // Unfiltered request has all fields
+        $this->assertArrayHasKey( 'description', $preload_data['/']['body'] );
+        $this->assertArrayHasKey( 'routes', $preload_data['/']['body'] );
+
+        // Filtered request only has the desired fields + links
+        $this->assertSame(
+            array_keys( $preload_data['/?_fields=description']['body'] ),
+            array( 'description', '_links' )
+        );
+    }
 }