Changeset 46456

Timestamp:

10/10/2019 05:16:44 PM (5 years ago)

Author:

kadamwhite

Message:

REST API: Fix error in _fields filtering logic where only one of several requested sibling properties would be included.

Props kadamwhite, TimothyBlynJacobs.
Fixes #48266.

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

@@ -744 +744 @@
         $ref   = &$fields_as_keyed;
         while ( count( $parts ) > 1 ) {
-            $next         = array_shift( $parts );
-            $ref[ $next ] = array();
+            $next = array_shift( $parts );
+            if ( isset( $ref[ $next ] ) && true === $ref[ $next ] ) {
+                // Skip any sub-properties if their parent prop is already marked for inclusion.
+                break 2;
+            }
+            $ref[ $next ] = isset( $ref[ $next ] ) ? $ref[ $next ] : array();
             $ref          = &$ref[ $next ];
         }

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

@@ -555 +555 @@
                 'd' => array(
                     '5' => 5,
+                ),
+            ),
+            $response->get_data()
+        );
+    }
+
+    /**
+     * Ensure that specifying a single top-level key in _fields includes that field and all children.
+     *
+     * @ticket 48266
+     */
+    public function test_rest_filter_response_fields_top_level_key() {
+        $response = new WP_REST_Response();
+
+        $response->set_data(
+            array(
+                'meta' => array(
+                    'key1' => 1,
+                    'key2' => 2,
+                ),
+            )
+        );
+        $request = array(
+            '_fields' => 'meta',
+        );
+
+        $response = rest_filter_response_fields( $response, null, $request );
+        $this->assertEquals(
+            array(
+                'meta' => array(
+                    'key1' => 1,
+                    'key2' => 2,
+                ),
+            ),
+            $response->get_data()
+        );
+    }
+
+    /**
+     * Ensure that a top-level key in _fields supersedes any specified children of that field.
+     *
+     * @ticket 48266
+     */
+    public function test_rest_filter_response_fields_child_after_parent() {
+        $response = new WP_REST_Response();
+
+        $response->set_data(
+            array(
+                'meta' => array(
+                    'key1' => 1,
+                    'key2' => 2,
+                ),
+            )
+        );
+        $request = array(
+            '_fields' => 'meta,meta.key1',
+        );
+
+        $response = rest_filter_response_fields( $response, null, $request );
+        $this->assertEquals(
+            array(
+                'meta' => array(
+                    'key1' => 1,
+                    'key2' => 2,
+                ),
+            ),
+            $response->get_data()
+        );
+    }
+
+    /**
+     * Ensure that specifying two sibling properties in _fields causes both to be included.
+     *
+     * @ticket 48266
+     */
+    public function test_rest_filter_response_fields_include_all_specified_siblings() {
+        $response = new WP_REST_Response();
+
+        $response->set_data(
+            array(
+                'meta' => array(
+                    'key1' => 1,
+                    'key2' => 2,
+                ),
+            )
+        );
+        $request = array(
+            '_fields' => 'meta.key1,meta.key2',
+        );
+
+        $response = rest_filter_response_fields( $response, null, $request );
+        $this->assertEquals(
+            array(
+                'meta' => array(
+                    'key1' => 1,
+                    'key2' => 2,
                 ),
             ),