Add a new endpoint that exposes block editor settings through the RES…

…T API (#29969) * Add a new endpoint that exposes block editor settings through the REST API * Update permission check * Global styles - Add check for mobile * Fix lint issues * Block editor mobile settings endpoint * Move theme support data within the if condition * Add schema * Update naming * Update endpoint name * Use require_once * Use block editor settings * Usage of get_default_block_editor_settings for the rest api endpoint * Block editor settings update schema * Add context as a param to get the block editor settings, update permissions check * Remove unneeded filter * Remove unneeded changes * Update context in schema * Update context for global styles attributes * Update class-wp-rest-block-editor-settings-controller.php Co-authored-by: Tugdual de Kerviler <[email protected]> Co-authored-by: Greg Ziółkowski <[email protected]>
WordPress · May 4, 2021 · 510a357 · 510a357
1 parent 12284ee
commit 510a357
Show file tree

Hide file tree

Showing 3 changed files with 279 additions and 0 deletions.
diff --git a/lib/class-wp-rest-block-editor-settings-controller.php b/lib/class-wp-rest-block-editor-settings-controller.php
@@ -0,0 +1,267 @@
+<?php
+/**
+ * REST API: WP_REST_Block_Editor_Settings_Controller class
+ *
+ * @package    WordPress
+ * @subpackage REST_API
+ */
+
+/**
+ * Core class used to retrieve the block editor settings via the REST API.
+ *
+ * @see WP_REST_Controller
+ */
+class WP_REST_Block_Editor_Settings_Controller extends WP_REST_Controller {
+	/**
+	 * Constructs the controller.
+	 */
+	public function __construct() {
+		$this->namespace = '__experimental/wp-block-editor/v1';
+		$this->rest_base = 'settings';
+	}
+
+	/**
+	 * Registers the necessary REST API routes.
+	 */
+	public function register_routes() {
+		register_rest_route(
+			$this->namespace,
+			'/' . $this->rest_base,
+			array(
+				array(
+					'methods'             => WP_REST_Server::READABLE,
+					'callback'            => array( $this, 'get_items' ),
+					'permission_callback' => array( $this, 'get_items_permissions_check' ),
+				),
+				'schema' => array( $this, 'get_public_item_schema' ),
+			)
+		);
+	}
+
+	/**
+	 * Checks whether a given request has permission to read block editor settings
+	 *
+	 * @since 5.8.0
+	 *
+	 * @param WP_REST_Request $request Full details about the request.
+	 *
+	 * @return WP_Error|bool True if the request has permission, WP_Error object otherwise.
+	 */
+	public function get_items_permissions_check( $request ) {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+		if ( current_user_can( 'edit_posts' ) ) {
+			return true;
+		}
+
+		foreach ( get_post_types( array( 'show_in_rest' => true ), 'objects' ) as $post_type ) {
+			if ( current_user_can( $post_type->cap->edit_posts ) ) {
+				return true;
+			}
+		}
+
+		return new WP_Error(
+			'rest_cannot_read_block_editor_settings',
+			__( 'Sorry, you are not allowed to read the block editor settings.', 'gutenberg' ),
+			array( 'status' => rest_authorization_required_code() )
+		);
+	}
+
+	/**
+	 * Returns the block editor's settings
+	 *
+	 * @since 5.8.0
+	 *
+	 * @param WP_REST_Request $request Full details about the request.
+	 *
+	 * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.
+	 */
+	public function get_items( $request ) {
+		$context  = ! empty( $request['context'] ) ? $request['context'] : 'post-editor';
+		$settings = gutenberg_get_block_editor_settings( $context );
+
+		return rest_ensure_response( $settings );
+	}
+
+	/**
+	 * Retrieves the block editor's settings schema, conforming to JSON Schema.
+	 *
+	 * @since 5.8.0
+	 *
+	 * @return array Item schema data.
+	 */
+	public function get_item_schema() {
+		if ( $this->schema ) {
+			return $this->add_additional_fields_schema( $this->schema );
+		}
+
+		$this->schema = array(
+			'$schema'    => 'http://json-schema.org/draft-04/schema#',
+			'title'      => 'block-editor-settings-item',
+			'type'       => 'object',
+			'properties' => array(
+				'__unstableEnableFullSiteEditingBlocks'  => array(
+					'description' => __( 'Enables experimental Full Site Editing blocks', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'styles'                                 => array(
+					'description' => __( 'Editor styles', 'gutenberg' ),
+					'type'        => 'array',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'supportsTemplateMode'                   => array(
+					'description' => __( 'Returns if the current theme is full site editing-enabled or not.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'supportsLayout'                         => array(
+					'description' => __( 'Enable/disable layouts support in container blocks.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'widgetTypesToHideFromLegacyWidgetBlock' => array(
+					'description' => __( 'Widget types to hide from Legacy Widget block.', 'gutenberg' ),
+					'type'        => 'array',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'__experimentalFeatures'                 => array(
+					'description' => __( 'Active theme settings and default values.', 'gutenberg' ),
+					'type'        => 'object',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'__experimentalGlobalStylesUserEntityId' => array(
+					'description' => __( 'Global styles user entity ID.', 'gutenberg' ),
+					'type'        => 'integer',
+					'context'     => array( 'site-editor' ),
+				),
+
+				'__experimentalGlobalStylesBaseStyles'   => array(
+					'description' => __( 'Global styles settings.', 'gutenberg' ),
+					'type'        => 'object',
+					'context'     => array( 'site-editor' ),
+				),
+
+				'alignWide'                              => array(
+					'description' => __( 'Enable/Disable Wide/Full Alignments.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'allowedBlockTypes'                      => array(
+					'description' => __( 'List of allowed block types.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'allowedMimeTypes'                       => array(
+					'description' => __( 'List of allowed mime types and file extensions.', 'gutenberg' ),
+					'type'        => 'object',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'blockCategories'                        => array(
+					'description' => __( 'Returns all the categories for block types that will be shown in the block editor.', 'gutenberg' ),
+					'type'        => 'array',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'disableCustomColors'                    => array(
+					'description' => __( 'Disables custom colors.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'disableCustomFontSizes'                 => array(
+					'description' => __( 'Disables custom font size.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'disableCustomGradients'                 => array(
+					'description' => __( 'Disables custom font size.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'enableCustomLineHeight'                 => array(
+					'description' => __( 'Enables custom line height.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'enableCustomSpacing'                    => array(
+					'description' => __( 'Enables custom spacing.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'enableCustomUnits'                      => array(
+					'description' => __( 'Enables custom units.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'isRTL'                                  => array(
+					'description' => __( 'Determines whether the current locale is right-to-left (RTL).', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'imageDefaultSize'                       => array(
+					'description' => __( 'Default size for images.', 'gutenberg' ),
+					'type'        => 'string',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'imageDimensions'                        => array(
+					'description' => __( 'Available image dimensions.', 'gutenberg' ),
+					'type'        => 'object',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'imageEditing'                           => array(
+					'description' => __( 'Determines whether the image editing feature is enabled.', 'gutenberg' ),
+					'type'        => 'boolean',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'imageSizes'                             => array(
+					'description' => __( 'Available image sizes.', 'gutenberg' ),
+					'type'        => 'array',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'maxUploadFileSize'                      => array(
+					'description' => __( 'Maximum upload size in bytes allowed for the site.', 'gutenberg' ),
+					'type'        => 'number',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'colors'                                 => array(
+					'description' => __( 'Active theme color palette.', 'gutenberg' ),
+					'type'        => 'array',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'fontSizes'                              => array(
+					'description' => __( 'Active theme font sizes.', 'gutenberg' ),
+					'type'        => 'array',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+
+				'gradients'                              => array(
+					'description' => __( 'Active theme gradients.', 'gutenberg' ),
+					'type'        => 'array',
+					'context'     => array( 'post-editor', 'site-editor', 'widgets-editor' ),
+				),
+			),
+		);
+
+		return $this->add_additional_fields_schema( $this->schema );
+	}
+}
diff --git a/lib/load.php b/lib/load.php
@@ -62,6 +62,9 @@ function gutenberg_is_experiment_enabled( $name ) {
 	if ( ! class_exists( 'WP_REST_Templates_Controller' ) ) {
 		require_once __DIR__ . '/full-site-editing/class-wp-rest-templates-controller.php';
 	}
+	if ( ! class_exists( 'WP_REST_Block_Editor_Settings_Controller' ) ) {
+		require_once dirname( __FILE__ ) . '/class-wp-rest-block-editor-settings-controller.php';
+	}
 	/**
 	* End: Include for phase 2
 	*/

diff --git a/lib/rest-api.php b/lib/rest-api.php
@@ -73,6 +73,15 @@ function gutenberg_register_batch_endpoint() {
 }
 add_action( 'rest_api_init', 'gutenberg_register_batch_endpoint' );
 
+/**
+ * Registers the Block editor settings REST API routes.
+ */
+function gutenberg_register_block_editor_settings() {
+	$editor_settings = new WP_REST_Block_Editor_Settings_Controller();
+	$editor_settings->register_routes();
+}
+add_action( 'rest_api_init', 'gutenberg_register_block_editor_settings' );
+
 /**
  * Hook in to the nav menu item post type and enable a post type rest endpoint.
  *