325 lines
12 KiB
PHP
325 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* REST API: WP_REST_Block_Editor_Settings_Controller class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage REST_API
|
|
*/
|
|
|
|
if ( ! class_exists( 'WP_REST_Block_Editor_Settings_Controller' ) ) {
|
|
|
|
/**
|
|
* 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 = '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 ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis
|
|
switch ( $request['context'] ) {
|
|
case 'post-editor':
|
|
default:
|
|
$editor_context_name = 'core/edit-post';
|
|
break;
|
|
case 'widgets-editor':
|
|
$editor_context_name = 'core/edit-widgets';
|
|
break;
|
|
case 'site-editor':
|
|
$editor_context_name = 'core/edit-site';
|
|
break;
|
|
case 'mobile':
|
|
$editor_context_name = 'core/mobile';
|
|
break;
|
|
}
|
|
|
|
add_filter( 'block_editor_settings_all', 'gutenberg_get_block_editor_settings_mobile', PHP_INT_MAX );
|
|
|
|
$editor_context = new WP_Block_Editor_Context( array( 'name' => $editor_context_name ) );
|
|
$settings = get_block_editor_settings( array(), $editor_context );
|
|
|
|
remove_filter( 'block_editor_settings_all', 'gutenberg_get_block_editor_settings_mobile', PHP_INT_MAX );
|
|
|
|
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 );
|
|
}
|
|
|
|
$schema = array(
|
|
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
|
'title' => 'block-editor-settings-item',
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'__unstableEnableFullSiteEditingBlocks' => array(
|
|
'description' => __( 'Enables experimental Site Editor 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' => __( 'Indicates whether the current theme supports block-based templates.', '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' => __( 'Settings consolidated from core, theme, and user origins.', 'gutenberg' ),
|
|
'type' => 'object',
|
|
'context' => array( 'post-editor', 'site-editor', 'widgets-editor', 'mobile' ),
|
|
),
|
|
|
|
'__experimentalStyles' => array(
|
|
'description' => __( 'Styles consolidated from core, theme, and user origins.', 'gutenberg' ),
|
|
'type' => 'object',
|
|
'context' => array( 'mobile' ),
|
|
),
|
|
|
|
'__experimentalEnableQuoteBlockV2' => array(
|
|
'description' => __( 'Whether the V2 of the quote block that uses inner blocks should be enabled.', 'gutenberg' ),
|
|
'type' => 'boolean',
|
|
'context' => array( 'mobile' ),
|
|
),
|
|
|
|
'__experimentalEnableListBlockV2' => array(
|
|
'description' => __( 'Whether the V2 of the list block that uses inner blocks should be enabled.', 'gutenberg' ),
|
|
'type' => 'boolean',
|
|
'context' => array( 'mobile' ),
|
|
),
|
|
|
|
'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' ),
|
|
),
|
|
|
|
'blockInspectorTabs' => array(
|
|
'description' => __( 'Block inspector tab display overrides.', 'gutenberg' ),
|
|
'type' => 'object',
|
|
'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' ),
|
|
),
|
|
|
|
'disableLayoutStyles' => array(
|
|
'description' => __( 'Disables output of layout styles.', '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' ),
|
|
),
|
|
'spacingSizes' => array(
|
|
'description' => __( 'Active theme spacing sizes.', 'gutenberg' ),
|
|
'type' => 'array',
|
|
'context' => array( 'post-editor', 'site-editor', 'widgets-editor' ),
|
|
),
|
|
'spacingScale' => array(
|
|
'description' => __( 'Active theme spacing scale.', 'gutenberg' ),
|
|
'type' => 'array',
|
|
'context' => array( 'post-editor', 'site-editor', 'widgets-editor' ),
|
|
),
|
|
'disableCustomSpacingSizes' => array(
|
|
'description' => __( 'Disables custom spacing sizes.', 'gutenberg' ),
|
|
'type' => 'boolean',
|
|
'context' => array( 'post-editor', 'site-editor', 'widgets-editor' ),
|
|
),
|
|
),
|
|
);
|
|
|
|
$this->schema = $schema;
|
|
|
|
return $this->add_additional_fields_schema( $this->schema );
|
|
}
|
|
}
|
|
}
|
