Changeset 47921

Timestamp:

06/07/2020 06:44:08 AM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Add additional fields to the themes controller.

When the themes controller was introduced it only returned a theme's supported features. This adds the majority of a theme's header information to the response.

Props ockham, spacedmonkey.
Fixes #49906.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php (modified) (3 diffs)
• tests/phpunit/data/themedir1/rest-api (added)
• tests/phpunit/data/themedir1/rest-api/style.css (added)
• tests/phpunit/tests/rest-api/rest-themes-controller.php (modified) (4 diffs)
• tests/phpunit/tests/theme/themeDir.php (modified) (1 diff)

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

@@ -116 +116 @@
         $fields = $this->get_fields_for_response( $request );
 
-        if ( in_array( 'theme_supports', $fields, true ) ) {
+        if ( rest_is_field_included( 'stylesheet', $fields ) ) {
+            $data['stylesheet'] = $theme->get_stylesheet();
+        }
+
+        if ( rest_is_field_included( 'template', $fields ) ) {
+            /**
+             * Use the get_template() method, not the 'Template' header, for finding the template.
+             * The 'Template' header is only good for what was written in the style.css, while
+             * get_template() takes into account where WordPress actually located the theme and
+             * whether it is actually valid.
+             */
+            $data['template'] = $theme->get_template();
+        }
+
+        $plain_field_mappings = array(
+            'requires_php' => 'RequiresPHP',
+            'requires_wp'  => 'RequiresWP',
+            'textdomain'   => 'TextDomain',
+            'version'      => 'Version',
+        );
+
+        foreach ( $plain_field_mappings as $field => $header ) {
+            if ( rest_is_field_included( $field, $fields ) ) {
+                $data[ $field ] = $theme->get( $header );
+            }
+        }
+
+        if ( rest_is_field_included( 'screenshot', $fields ) ) {
+            // Using $theme->get_screenshot() with no args to get absolute URL.
+            $data['screenshot'] = $theme->get_screenshot() ?: '';
+        }
+
+        $rich_field_mappings = array(
+            'author'      => 'Author',
+            'author_uri'  => 'AuthorURI',
+            'description' => 'Description',
+            'name'        => 'Name',
+            'tags'        => 'Tags',
+            'theme_uri'   => 'ThemeURI',
+        );
+
+        foreach ( $rich_field_mappings as $field => $header ) {
+            if ( rest_is_field_included( "{$field}.raw", $fields ) ) {
+                $data[ $field ]['raw'] = $theme->display( $header, false, true );
+            }
+
+            if ( rest_is_field_included( "{$field}.rendered", $fields ) ) {
+                $data[ $field ]['rendered'] = $theme->display( $header );
+            }
+        }
+
+        if ( rest_is_field_included( 'theme_supports', $fields ) ) {
             $item_schemas   = $this->get_item_schema();
             $theme_supports = $item_schemas['properties']['theme_supports']['properties'];
             foreach ( $theme_supports as $name => $schema ) {
+
+
+
+
                 if ( 'formats' === $name ) {
                     continue;
@@ -193 +248 @@
             'type'       => 'object',
             'properties' => array(
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                 'theme_supports' => array(
                     'description' => __( 'Features supported by this theme.' ),
@@ -459 +625 @@
                     ),
                 ),
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
             ),
         );

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

@@ -126 +126 @@
 
         wp_set_current_user( self::$contributor_id );
+
     }
 
@@ -151 +152 @@
         $this->check_get_theme_response( $response );
         $fields = array(
+
+
+
+
+
+
+
+
+
+
+
             'theme_supports',
+
+
         );
         $this->assertEqualSets( $fields, array_keys( $data[0] ) );
@@ -208 +222 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 1, count( $properties ) );
+        $this->assertEquals( 14, count( $properties ) );
+
+        $this->assertArrayHasKey( 'author', $properties );
+        $this->assertArrayHasKey( 'raw', $properties['author']['properties'] );
+        $this->assertArrayHasKey( 'rendered', $properties['author']['properties'] );
+
+        $this->assertArrayHasKey( 'author_uri', $properties );
+        $this->assertArrayHasKey( 'raw', $properties['author_uri']['properties'] );
+        $this->assertArrayHasKey( 'rendered', $properties['author_uri']['properties'] );
+
+        $this->assertArrayHasKey( 'description', $properties );
+        $this->assertArrayHasKey( 'raw', $properties['description']['properties'] );
+        $this->assertArrayHasKey( 'rendered', $properties['description']['properties'] );
+
+        $this->assertArrayHasKey( 'name', $properties );
+        $this->assertArrayHasKey( 'raw', $properties['name']['properties'] );
+        $this->assertArrayHasKey( 'rendered', $properties['name']['properties'] );
+
+        $this->assertArrayHasKey( 'requires_php', $properties );
+        $this->assertArrayHasKey( 'requires_wp', $properties );
+        $this->assertArrayHasKey( 'screenshot', $properties );
+        $this->assertArrayHasKey( 'stylesheet', $properties );
+
+        $this->assertArrayHasKey( 'tags', $properties );
+        $this->assertArrayHasKey( 'raw', $properties['tags']['properties'] );
+        $this->assertArrayHasKey( 'items', $properties['tags']['properties']['raw'] );
+        $this->assertArrayHasKey( 'rendered', $properties['tags']['properties'] );
+
+        $this->assertArrayHasKey( 'template', $properties );
+        $this->assertArrayHasKey( 'textdomain', $properties );
         $this->assertArrayHasKey( 'theme_supports', $properties );
+
+
+
+
+
+
+
         $theme_supports = $properties['theme_supports']['properties'];
         $this->assertEquals( 20, count( $theme_supports ) );
@@ -235 +285 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * @ticket 49037
      */

trunk/tests/phpunit/tests/theme/themeDir.php

@@ -164 +164 @@
             'Internationalized Theme',
             'camelCase',
+
         );