Changeset 44254 for trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

Timestamp:

12/17/2018 01:14:17 AM (6 years ago)

Author:

SergeyBiryukov

Message:

REST API: Include fields with null schema in get_fields_for_response().

In [43736], we prevented rendering fields when not present in ?_fields=. However, because get_fields_for_response() is dependent on get_item_schema(), any custom fields registered with a null schema would be incorrectly excluded from the response. Because the REST API permits a null schema for register_rest_field(), those fields should be included in the available fields for a response.

Props danielbachhuber.
Merges [43908] to trunk.
Fixes #45220.

Location:

trunk

Files:

• . (modified) (1 prop)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)

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

@@ -3762 +3762 @@
     }
 
+    /**
+     * @ticket 45220
+     */
+    public function test_get_additional_field_registration_null_schema() {
+        register_rest_field(
+            'post',
+            'my_custom_int',
+            array(
+                'schema'          => null,
+                'get_callback'    => array( $this, 'additional_field_get_callback' ),
+                'update_callback' => null,
+            )
+        );
+        $post_id = $this->factory->post->create();
+
+        // 'my_custom_int' should appear because ?_fields= isn't set.
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/posts/' . $post_id );
+        $response = $this->server->dispatch( $request );
+        $this->assertArrayHasKey( 'my_custom_int', $response->data );
+
+        // 'my_custom_int' should appear because it's present in ?_fields=.
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . $post_id );
+        $request->set_param( '_fields', 'title,my_custom_int' );
+        $response = $this->server->dispatch( $request );
+        $this->assertArrayHasKey( 'my_custom_int', $response->data );
+
+        // 'my_custom_int' should not appear because it's not present in ?_fields=.
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . $post_id );
+        $request->set_param( '_fields', 'title' );
+        $response = $this->server->dispatch( $request );
+        $this->assertArrayNotHasKey( 'my_custom_int', $response->data );
+
+        global $wp_rest_additional_fields;
+        $wp_rest_additional_fields = array();
+    }
+
     public function test_additional_field_update_errors() {
         $schema = array(