Changeset 52374

Timestamp:

12/14/2021 04:29:03 PM (5 weeks ago)

Author:

spacedmonkey

Message:

REST API: Ensure that the get_theme_item method should respect fields param.

Fix the get_theme_item method in the WP_REST_Global_Styles_Controller class to respect the fields param context filtering and to return links.

Props spacedmonkey, hellofromtonya, peterwilsoncc, costdev.
Fixes #54595.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-global-styles-controller.php (modified) (3 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php

@@ -378 +378 @@
 
         $links = array(
-            'self'       => array(
+            'self' => array(
                 'href' => rest_url( trailingslashit( $base ) . $id ),
-            ),
-            'collection' => array(
-                'href' => rest_url( $base ),
             ),
         );
@@ -536 +533 @@
         }
 
-        $theme    = WP_Theme_JSON_Resolver::get_merged_data( 'theme' );
-        $styles   = $theme->get_raw_data()['styles'];
-        $settings = $theme->get_settings();
-        $result   = array(
-            'settings' => $settings,
-            'styles'   => $styles,
+        $theme  = WP_Theme_JSON_Resolver::get_merged_data( 'theme' );
+        $data   = array();
+        $fields = $this->get_fields_for_response( $request );
+
+        if ( rest_is_field_included( 'settings', $fields ) ) {
+            $data['settings'] = $theme->get_settings();
+        }
+
+        if ( rest_is_field_included( 'styles', $fields ) ) {
+            $data['styles'] = $theme->get_raw_data()['styles'];
+        }
+
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+        $data    = $this->add_additional_fields_to_object( $data, $request );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        $response = rest_ensure_response( $data );
+
+        $links = array(
+            'self' => array(
+                'href' => rest_url( sprintf( '%s/%s/themes/%s', $this->namespace, $this->rest_base, $request['stylesheet'] ) ),
+            ),
         );
-        $response = rest_ensure_response( $result );
+
+        $response->add_links( $links );
 
         return $response;

trunk/tests/phpunit/tests/rest-api/rest-global-styles-controller.php

@@ -153 +153 @@
         $response = rest_get_server()->dispatch( $request );
         $data     = $response->get_data();
-        unset( $data['_links'] );
-
+        $links    = $response->get_links();
         $this->assertArrayHasKey( 'settings', $data );
         $this->assertArrayHasKey( 'styles', $data );
+        $this->assertArrayHasKey( 'self', $links );
+        $this->assertStringContainsString( '/wp/v2/global-styles/themes/tt1-blocks', $links['self'][0]['href'] );
+    }
+
+    /**
+     * @covers WP_REST_Global_Styles_Controller::get_theme_item
+     * @ticket 54595
+     */
+    public function test_get_theme_item_fields() {
+        wp_set_current_user( self::$admin_id );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/themes/tt1-blocks' );
+        $request->set_param( '_fields', 'settings' );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $this->assertArrayHasKey( 'settings', $data );
+        $this->assertArrayNotHasKey( 'styles', $data );
     }
 
@@ -224 +239 @@
         $response = rest_get_server()->dispatch( $request );
         $data     = $response->get_data();
-        unset( $data['_links'] );
+        $links    = $response->get_links();
 
         $this->assertEquals(
@@ -238 +253 @@
             $data
         );
+
+        $this->assertArrayHasKey( 'self', $links );
+        $this->assertStringContainsString( '/wp/v2/global-styles/' . self::$global_styles_id, $links['self'][0]['href'] );
     }