Changeset 47563 for branches/5.4

Timestamp:

04/09/2020 10:52:45 PM (6 years ago)

Author:

whyisjake

Message:

REST API: Fix _fields filtering of registered rest fields.

Use rest_is_field_included when determining which additional fields to include to permit filtering by nested field properties.

Backportting r47511 to the 5.4 branch.

Props Dudo, kadamwhite, TimothyBlynJacobs.
Fixes #49648.

Location:

branches/5.4

Files:

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

branches/5.4/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php

@@ -452 +452 @@
                         }
 
-                        if ( ! in_array( $field_name, $requested_fields, true ) ) {
+                        if ( ! rest_is_field_included( $field_name, $requested_fields ) ) {
                                 continue;
                         }

branches/5.4/tests/phpunit/tests/rest-api.php

@@ -555 +555 @@
                                 'd' => array(
                                         '5' => 5,
+                                ),
+                        ),
+                        $response->get_data()
+                );
+        }
+
+        /**
+         * Ensure inclusion of deeply nested fields may be controlled with request['_fields'].
+         *
+         * @ticket 49648
+         */
+        public function test_rest_filter_response_fields_deeply_nested_field_filter() {
+                $response = new WP_REST_Response();
+
+                $response->set_data(
+                        array(
+                                'field' => array(
+                                        'a' => array(
+                                                'i'  => 'value i',
+                                                'ii' => 'value ii',
+                                        ),
+                                        'b' => array(
+                                                'iii' => 'value iii',
+                                                'iv'  => 'value iv',
+                                        ),
+                                ),
+                        )
+                );
+                $request = array(
+                        '_fields' => 'field.a.i,field.b.iv',
+                );
+
+                $response = rest_filter_response_fields( $response, null, $request );
+                $this->assertEquals(
+                        array(
+                                'field' => array(
+                                        'a' => array(
+                                                'i' => 'value i',
+                                        ),
+                                        'b' => array(
+                                                'iv' => 'value iv',
+                                        ),
                                 ),
                         ),

branches/5.4/tests/phpunit/tests/rest-api/rest-controller.php

@@ -43 +43 @@
                         )
                 );
+        }
+
+        public function tearDown() {
+                parent::tearDown();
+
+                global $wp_rest_additional_fields;
+                $wp_rest_additional_fields = array();
         }
 
@@ -417 +424 @@
                 $this->assertTrue( $listener->get_call_count( $method ) > $first_call_count );
         }
+
+        /**
+         * @dataProvider data_filter_nested_registered_rest_fields
+         * @ticket 49648
+         */
+        public function test_filter_nested_registered_rest_fields( $filter, $expected ) {
+                $controller = new WP_REST_Test_Controller();
+
+                register_rest_field(
+                        'type',
+                        'field',
+                        array(
+                                'schema'       => array(
+                                        'type'        => 'object',
+                                        'description' => 'A complex object',
+                                        'context'     => array( 'view', 'edit' ),
+                                        'properties'  => array(
+                                                'a' => array(
+                                                        'i'  => 'string',
+                                                        'ii' => 'string',
+                                                ),
+                                                'b' => array(
+                                                        'iii' => 'string',
+                                                        'iv'  => 'string',
+                                                ),
+                                        ),
+                                ),
+                                'get_callback' => array( $this, 'register_nested_rest_field_get_callback' ),
+                        )
+                );
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
+                $request->set_param( '_fields', $filter );
+
+                $response = $controller->prepare_item_for_response( array(), $request );
+                $response = rest_filter_response_fields( $response, rest_get_server(), $request );
+
+                $this->assertEquals( $expected, $response->get_data() );
+        }
+
+        public function register_nested_rest_field_get_callback() {
+                return array(
+                        'a' => array(
+                                'i'  => 'value i',
+                                'ii' => 'value ii',
+                        ),
+                        'b' => array(
+                                'iii' => 'value iii',
+                                'iv'  => 'value iv',
+                        ),
+                );
+        }
+
+        public function data_filter_nested_registered_rest_fields() {
+                return array(
+                        array(
+                                'field',
+                                array(
+                                        'field' => array(
+                                                'a' => array(
+                                                        'i'  => 'value i',
+                                                        'ii' => 'value ii',
+                                                ),
+                                                'b' => array(
+                                                        'iii' => 'value iii',
+                                                        'iv'  => 'value iv',
+                                                ),
+                                        ),
+                                ),
+                        ),
+                        array(
+                                'field.a',
+                                array(
+                                        'field' => array(
+                                                'a' => array(
+                                                        'i'  => 'value i',
+                                                        'ii' => 'value ii',
+                                                ),
+                                        ),
+                                ),
+                        ),
+                        array(
+                                'field.b',
+                                array(
+                                        'field' => array(
+                                                'b' => array(
+                                                        'iii' => 'value iii',
+                                                        'iv'  => 'value iv',
+                                                ),
+                                        ),
+                                ),
+                        ),
+                        array(
+                                'field.a.i,field.b.iv',
+                                array(
+                                        'field' => array(
+                                                'a' => array(
+                                                        'i' => 'value i',
+                                                ),
+                                                'b' => array(
+                                                        'iv' => 'value iv',
+                                                ),
+                                        ),
+                                ),
+                        ),
+                        array(
+                                'field.a,field.b.iii',
+                                array(
+                                        'field' => array(
+                                                'a' => array(
+                                                        'i'  => 'value i',
+                                                        'ii' => 'value ii',
+                                                ),
+                                                'b' => array(
+                                                        'iii' => 'value iii',
+                                                ),
+                                        ),
+                                ),
+                        ),
+                );
+        }
 }