Expose theme_supports data through a minimial theme controller

lib/class-wp-rest-themes-controller.php

@@ -0,0 +1,233 @@
+<?php
+/**
+ * REST API: WP_REST_Themes_Controller class
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 5.0.0
+ */
+
+/**
+ * Core class used to manage themes via the REST API.
+ *
+ * @since 5.0.0
+ *
+ * @see WP_REST_Controller
+ */
+class WP_REST_Themes_Controller extends WP_REST_Controller {
+
+	/**
+	 * Constructor.
+	 *
+	 * @since 5.0.0
+	 */
+	public function __construct() {
+		$this->namespace = 'wp/v2';
+		$this->rest_base = 'themes';
+	}
+
+	/**
+	 * Registers the routes for the objects of the controller.
+	 *
+	 * @since 5.0.0
+	 *
+	 * @see register_rest_route()
+	 */
+	public function register_routes() {
+		register_rest_route(
+			$this->namespace,
+			'/' . $this->rest_base . '/active',
+			array(
+				array(
+					'methods'             => WP_REST_Server::READABLE,
+					'callback'            => array( $this, 'get_item' ),
+					'permission_callback' => array( $this, 'get_item_permissions_check' ),
+					'args'                => array(
+						'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+					),
+				),
+				'schema' => array( $this, 'get_item_schema' ),
+			)
+		);
+	}
+
+	/**
+	 * Checks if a given request has access to read the theme.
+	 *
+	 * @since 5.0.0
+	 *
+	 * @param WP_REST_Request $request Full details about the request.
+	 * @return true|WP_Error True if the request has read access for the item, otherwise WP_Error object.
+	 */
+	public function get_item_permissions_check( $request ) {
+		if ( ! is_user_logged_in() || ! current_user_can( 'edit_posts' ) ) {
+			return new WP_Error( 'rest_user_cannot_view', __( 'Sorry, you are not allowed to view themes.' ), array( 'status' => rest_authorization_required_code() ) );
+		}
+
+		return true;
+	}
+
+	/**
+	 * Retrieves the active theme.
+	 *
+	 * @since 5.0.0
+	 *
+	 * @param WP_REST_Request $request Full details about the request.
+	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+	 */
+	public function get_item( $request ) {
+		$theme = wp_get_theme();
+
+		$response = $this->prepare_item_for_response( $theme, $request );
+		$response = rest_ensure_response( $response );
+
+		return $response;
+	}
+
+	/**
+	 * Prepares a single theme output for response.
+	 *
+	 * @since 5.0.0
+	 *
+	 * @param WP_Theme        $theme   Theme object.
+	 * @param WP_REST_Request $request Request object.
+	 * @return WP_REST_Response Response object.
+	 */
+	public function prepare_item_for_response( $theme, $request ) {
+		$data   = array();
+		$fields = $this->get_fields_for_response( $request );
+
+		if ( in_array( 'name', $fields, true ) ) {
+			$data['name'] = $theme->__get( 'name' );
+		}
+
+		if ( in_array( 'stylesheet', $fields, true ) ) {
+			$data['stylesheet'] = $theme->__get( 'stylesheet' );
+		}
+
+		if ( in_array( 'version', $fields, true ) ) {
+			$data['version'] = $theme->__get( 'version' );
+		}
+
+		if ( in_array( 'template', $fields, true ) ) {
+			$data['template'] = $theme->__get( 'template' );
+		}
+
+		if ( in_array( 'theme_supports', $fields, true ) ) {
+			$formats                           = get_theme_support( 'post-formats' );
+			$formats                           = is_array( $formats ) ? array_values( $formats[0] ) : array();
+			$formats                           = array_merge( array( 'standard' ), $formats );
+			$data['theme_supports']['formats'] = $formats;
+
+			$post_thumbnails = get_theme_support( 'post-thumbnails' );
+
+			if ( $post_thumbnails ) {
+				// $post_thumbnails can contain a nested array of post types.
+				// e.g. array( array( 'post', 'page' ) ).
+				$data['theme_supports']['post-thumbnails'] = is_array( $post_thumbnails ) ? $post_thumbnails[0] : true;
+			}
+		}
+
+		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+
+		$data = $this->add_additional_fields_to_object( $data, $request );
+		$data = $this->filter_response_by_context( $data, $context );
+
+		// Wrap the data in a response object.
+		$response = rest_ensure_response( $data );
+
+		$response->add_links( $this->prepare_links( $theme ) );
+
+		/**
+		 * Filters theme data returned from the REST API.
+		 *
+		 * @since 5.0.0
+		 *
+		 * @param WP_REST_Response $response The response object.
+		 * @param WP_Theme         $theme    Theme object used to create response.
+		 * @param WP_REST_Request  $request  Request object.
+		 */
+		return apply_filters( 'rest_prepare_theme', $response, $theme, $request );
+	}
+
+	/**
+	 * Prepares links for the theme request.
+	 *
+	 * @since 5.0.0
+	 *
+	 * @param WP_Theme $theme Theme object.
+	 * @return array Links for the given theme.
+	 */
+	protected function prepare_links( $theme ) {
+		$links = array(
+			'self' => array(
+				'href' => rest_url( sprintf( '%s/%s/active', $this->namespace, $this->rest_base ) ),
+			),
+		);
+
+		return $links;
+	}
+
+	/**
+	 * Retrieves the theme's schema, conforming to JSON Schema.
+	 *
+	 * @since 5.0.0
+	 *
+	 * @return array Item schema data.
+	 */
+	public function get_item_schema() {
+		$schema = array(
+			'$schema'    => 'http://json-schema.org/draft-04/schema#',
+			'title'      => 'theme',
+			'type'       => 'object',
+			'properties' => array(
+				'name'           => array(
+					'description' => __( 'Theme name', 'gutenberg' ),
+					'type'        => 'string',
+					'context'     => array( 'edit' ),
+					'readonly'    => true,
+				),
+				'stylesheet'     => array(
+					'description' => __( 'The directory name of the theme.', 'gutenberg' ),
+					'type'        => 'string',
+					'context'     => array( 'edit' ),
+					'readonly'    => true,
+				),
+				'version'        => array(
+					'description' => __( 'Theme version', 'gutenberg' ),
+					'type'        => 'string',
+					'context'     => array( 'edit' ),
+					'readonly'    => true,
+				),
+				'template'       => array(
+					'description' => __( 'The theme template', 'gutenberg' ),
+					'type'        => 'string',
+					'context'     => array( 'edit' ),
+					'readonly'    => true,
+				),
+				'theme_supports' => array(
+					'description' => __( 'A list of features this theme supports.', 'gutenberg' ),
+					'type'        => 'array',
+					'context'     => array( 'edit' ),
+					'readonly'    => true,
+					'properties'  => array(
+						'formats'         => array(
+							'description' => __( 'Post formats supported.', 'gutenberg' ),
+							'type'        => 'array',
+							'context'     => array( 'edit' ),
+							'readonly'    => true,
+						),
+						'post-thumbnails' => array(
+							'description' => __( 'Whether the theme supports post thumbnails.', 'gutenberg' ),
+							'type'        => array( 'array', 'bool' ),
+							'context'     => array( 'edit' ),
+							'readonly'    => true,
+						),
+					),
+				),
+			),
+		);
+
+		return $this->add_additional_fields_schema( $schema );
+	}
+}

lib/client-assets.php

@@ -1304,6 +1304,7 @@ function gutenberg_editor_scripts_and_styles( $hook ) {
 		'/',
 		'/wp/v2/types?context=edit',
 		'/wp/v2/taxonomies?per_page=-1&context=edit',
+		'/wp/v2/themes/active',
 		sprintf( '/wp/v2/%s/%s?context=edit', $rest_base, $post->ID ),
 		sprintf( '/wp/v2/types/%s?context=edit', $post_type ),
 		sprintf( '/wp/v2/users/me?post_type=%s&context=edit', $post_type ),

lib/load.php

@@ -15,6 +15,7 @@
 	require dirname( __FILE__ ) . '/class-wp-rest-blocks-controller.php';
 	require dirname( __FILE__ ) . '/class-wp-rest-autosaves-controller.php';
 	require dirname( __FILE__ ) . '/class-wp-rest-block-renderer-controller.php';
+	require dirname( __FILE__ ) . '/class-wp-rest-themes-controller.php';
 	require dirname( __FILE__ ) . '/class-wp-rest-search-controller.php';
 	require dirname( __FILE__ ) . '/class-wp-rest-search-handler.php';
 	require dirname( __FILE__ ) . '/class-wp-rest-post-search-handler.php';

lib/rest-api.php

@@ -45,6 +45,9 @@ function gutenberg_register_rest_routes() {
 		$autosaves_controller = new WP_REST_Autosaves_Controller( $post_type->name );
 		$autosaves_controller->register_routes();
 	}
+
+	$themes_controller = new WP_REST_Themes_Controller();
+	$themes_controller->register_routes();
 }
 add_action( 'rest_api_init', 'gutenberg_register_rest_routes' );
 
@@ -304,40 +307,6 @@ function gutenberg_register_taxonomy_prepare_functions( $taxonomy ) {
 }
 add_filter( 'registered_taxonomy', 'gutenberg_register_taxonomy_prepare_functions' );
 
-/**
- * Ensure that the wp-json index contains the 'theme-supports' setting as
- * part of its site info elements.
- *
- * @see https://core.trac.wordpress.org/ticket/45016
- *
- * @param WP_REST_Response $response WP REST API response of the wp-json index.
- * @return WP_REST_Response Response that contains theme-supports.
- */
-function gutenberg_ensure_wp_json_has_theme_supports( $response ) {
-	$site_info = $response->get_data();
-	if ( ! array_key_exists( 'theme_supports', $site_info ) ) {
-		$site_info['theme_supports'] = array();
-	}
-	if ( ! array_key_exists( 'formats', $site_info['theme_supports'] ) ) {
-		$formats = get_theme_support( 'post-formats' );
-		$formats = is_array( $formats ) ? array_values( $formats[0] ) : array();
-		$formats = array_merge( array( 'standard' ), $formats );
-
-		$site_info['theme_supports']['formats'] = $formats;
-	}
-	if ( ! array_key_exists( 'post-thumbnails', $site_info['theme_supports'] ) ) {
-		$post_thumbnails = get_theme_support( 'post-thumbnails' );
-		if ( $post_thumbnails ) {
-			// $post_thumbnails can contain a nested array of post types.
-			// e.g. array( array( 'post', 'page' ) ).
-			$site_info['theme_supports']['post-thumbnails'] = is_array( $post_thumbnails ) ? $post_thumbnails[0] : true;
-		}
-	}
-	$response->set_data( $site_info );
-	return $response;
-}
-add_filter( 'rest_index', 'gutenberg_ensure_wp_json_has_theme_supports' );
-
 /**
  * Handle any necessary checks early.
  *

packages/core-data/src/actions.js

@@ -69,14 +69,14 @@ export function receiveEntityRecords( kind, name, records, query ) {
 /**
  * Returns an action object used in signalling that the index has been received.
  *
- * @param {Object} index Index received.
+ * @param {Object} themeSupports Theme support for the current theme.
  *
  * @return {Object} Action object.
  */
-export function receiveThemeSupportsFromIndex( index ) {
+export function receiveThemeSupports( themeSupports ) {
 	return {
 		type: 'RECEIVE_THEME_SUPPORTS',
-		themeSupports: index.theme_supports,
+		themeSupports,
 	};
 }
 

packages/core-data/src/resolvers.js

@@ -14,7 +14,7 @@ import { addQueryArgs } from '@wordpress/url';
 import {
 	receiveUserQuery,
 	receiveEntityRecords,
-	receiveThemeSupportsFromIndex,
+	receiveThemeSupports,
 	receiveEmbedPreview,
 } from './actions';
 import { getKindEntities } from './entities';
@@ -70,8 +70,8 @@ export function* getEntityRecords( kind, name, query = {} ) {
  * Requests theme supports data from the index.
  */
 export function* getThemeSupports() {
-	const index = yield apiFetch( { path: '/' } );
-	yield receiveThemeSupportsFromIndex( index );
+	const currentTheme = yield apiFetch( { path: '/wp/v2/themes/active' } );
+	yield receiveThemeSupports( currentTheme.theme_supports );
 }
 
 /**

phpunit/class-gutenberg-rest-api-test.php

@@ -297,47 +297,6 @@ function test_link_term_management_per_user() {
 		$this->assertTrue( isset( $links[ $assign_categories ] ) );
 	}
 
-	/**
-	 * Should include relevant data in the 'theme_supports' key of index.
-	 */
-	function test_theme_supports_index() {
-		$request  = new WP_REST_Request( 'GET', '/' );
-		$response = rest_do_request( $request );
-		$result   = $response->get_data();
-		$this->assertTrue( isset( $result['theme_supports'] ) );
-		$this->assertTrue( isset( $result['theme_supports']['formats'] ) );
-		$this->assertTrue( in_array( 'standard', $result['theme_supports']['formats'] ) );
-	}
-
-	public function test_theme_supports_post_thumbnails_false() {
-		remove_theme_support( 'post-thumbnails' );
-		$request  = new WP_REST_Request( 'GET', '/' );
-		$response = rest_do_request( $request );
-		$result   = $response->get_data();
-		$this->assertTrue( isset( $result['theme_supports'] ) );
-		$this->assertFalse( isset( $result['theme_supports']['post-thumbnails'] ) );
-	}
-
-	public function test_theme_supports_post_thumbnails_true() {
-		remove_theme_support( 'post-thumbnails' );
-		add_theme_support( 'post-thumbnails' );
-		$request  = new WP_REST_Request( 'GET', '/' );
-		$response = rest_do_request( $request );
-		$result   = $response->get_data();
-		$this->assertTrue( isset( $result['theme_supports'] ) );
-		$this->assertEquals( true, $result['theme_supports']['post-thumbnails'] );
-	}
-
-	public function test_theme_supports_post_thumbnails_array() {
-		remove_theme_support( 'post-thumbnails' );
-		add_theme_support( 'post-thumbnails', array( 'post' ) );
-		$request  = new WP_REST_Request( 'GET', '/' );
-		$response = rest_do_request( $request );
-		$result   = $response->get_data();
-		$this->assertTrue( isset( $result['theme_supports'] ) );
-		$this->assertEquals( array( 'post' ), $result['theme_supports']['post-thumbnails'] );
-	}
-
 	public function test_get_taxonomies_context_edit() {
 		wp_set_current_user( $this->contributor );
 		$request = new WP_REST_Request( 'GET', '/wp/v2/taxonomies' );