Skip to content

Add a new endpoint that exposes block editor settings through the REST API #29969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
geriux merged 24 commits into from
May 4, 2021
Merged

Add a new endpoint that exposes block editor settings through the REST API #29969

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
484e3ee
Add a new endpoint that exposes block editor settings through the RES…
Tug Sep 10, 2020
9737fbc
Merge branch 'master' into add/block-editor-settings-rest-endpoint
Feb 25, 2021
0b90f30
Update permission check
Feb 25, 2021
ba80bcc
Global styles - Add check for mobile
Mar 1, 2021
d1cc0f5
Fix lint issues
Mar 1, 2021
1cfd9d1
Merge branch 'trunk' into add/block-editor-settings-rest-endpoint
Mar 15, 2021
052d241
Block editor mobile settings endpoint
Mar 16, 2021
b4205d5
Move theme support data within the if condition
Mar 17, 2021
d332e6e
Add schema
Mar 18, 2021
e3e1c77
Update naming
Mar 18, 2021
2c7abac
Update endpoint name
Mar 22, 2021
ffe9ac1
Use require_once
Mar 22, 2021
6837fa7
Use block editor settings
Mar 25, 2021
d9f3277
Merge branch 'trunk' into add/global-styles-mobile-endpoint
Apr 8, 2021
e18eaa3
Merge branch 'trunk' into add/global-styles-mobile-endpoint
Apr 19, 2021
2328ff6
Usage of get_default_block_editor_settings for the rest api endpoint
Apr 5, 2021
ede0fc1
Block editor settings update schema
Apr 19, 2021
ddb0dcd
Merge branch 'trunk' into add/global-styles-mobile-endpoint
Apr 20, 2021
3a3908f
Add context as a param to get the block editor settings, update permi…
Apr 20, 2021
108debd
Remove unneeded filter
Apr 20, 2021
2d24002
Remove unneeded changes
Apr 20, 2021
ec6fa21
Update context in schema
Apr 21, 2021
f5db2fc
Update context for global styles attributes
Apr 26, 2021
3897d19
Update class-wp-rest-block-editor-settings-controller.php
gziolo May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Use block editor settings
  • Loading branch information
Gerardo Pacheco committed Mar 25, 2021
commit 6837fa773727794fb7fff0d3646875989399274b
45 changes: 19 additions & 26 deletions ...tor-global-styles-settings-controller.php → ...rest-block-editor-settings-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
<?php
/**
* REST API: WP_REST_Block_Editor_Global_Styles_Settings_Controller class
* REST API: WP_REST_Block_Editor_Settings_Controller class
*
* @package WordPress
* @subpackage REST_API
*/

/**
* Core class used to retrieve the block editor global styles settings via the REST API.
* Core class used to retrieve the block editor settings via the REST API.
*
* @see WP_REST_Controller
*/
class WP_REST_Block_Editor_Global_Styles_Settings_Controller extends 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 = 'global-styles';
$this->rest_base = 'settings';
}

/**
Expand Down Expand Up @@ -57,7 +57,7 @@ public function get_items_permissions_check( $request ) {// phpcs:ignore Variabl
}

/**
* Returns the block editor's global styles settings
* Returns the block editor's settings
*
* @since 5.8.0
*
Expand All @@ -66,13 +66,18 @@ public function get_items_permissions_check( $request ) {// phpcs:ignore Variabl
* @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.UnusedVariable
$settings = apply_filters( 'block_editor_global_styles_rest_settings', array() );
$settings = apply_filters( 'block_editor_settings', array() );
unset( $settings['styles'] );
unset( $settings['defaultEditorStyles'] );
unset( $settings['availableLegacyWidgets'] );
unset( $settings['__unstableEnableFullSiteEditingBlocks'] );
unset( $settings['__experimentalGlobalStylesUserEntityId'] );

return rest_ensure_response( $settings );
}

/**
* Retrieves the block editor's global styles schema, conforming to JSON Schema.
* Retrieves the block editor's settings schema, conforming to JSON Schema.
*
* @since 5.8.0
*
Expand All @@ -85,34 +90,22 @@ public function get_item_schema() {

$this->schema = array(
Copy link
Member

@oandregal oandregal Apr 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds great. It looks like there are some items that are off in terms of in which context they're available. Some that I've noticed that should be site-editor only are: __experimentalGlobalStylesUserEntityId, __experimentalGlobalStylesBaseStyles. Other than that, it seems that we can land this PR already? The global styles settings use the old filter block_editor_settings and we should update it but it doesn't block this PR, as far as I'm aware.

Also: any thoughts on best practices to keep this schema up to date as things evolve would be great.

Copy link
Member

@gziolo gziolo Apr 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also: any thoughts on best practices to keep this schema up to date as things evolve would be great.

If we would start using the same endpoint for the web then it could help to maintain the schema 😄

In related efforts, I plan we switch to the REST API endpoint for block types on the web rather than expose them with JS function call on the server.

Copy link
Member Author

@geriux geriux Apr 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @nosolosw !

Some that I've noticed that should be site-editor only are: __experimentalGlobalStylesUserEntityId, __experimentalGlobalStylesBaseStyles

I updated those to be site-editor only.

The global styles settings use the old filter block_editor_settings and we should update it but it doesn't block this PR, as far as I'm aware.

Awesome 😃! Do you know more or less when that's going to be updated?

Copy link
Member

@oandregal oandregal May 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just merged #31762 which adds more data for mobile. Upon hitting the button, it just occurred to me that something was off. I think it boils down to the contexts we define in this PR: post-editor, site-editor, widgets-editor. Shouldn't we also have a mobile context?

My understanding is that we use this to filter what kind of data we pass through the request. If the plan is to move the settings retrieval to use the REST request, checks like https://github.com/WordPress/gutenberg/pull/31762/files#diff-0b8e98dead5542e95159bd3c482158111d3f16637e7eef9af13373358fa42dedR91 don't make sense. However, the current contexts are also not enough. I'm thinking we actually need a mobile context as well. @geriux et all, do you have thoughts on this?

Copy link
Member Author

@geriux geriux May 14, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking we actually need a mobile context as well. @geriux et all, do you have thoughts on this?

I think we might if we want specific data like the consolidated styles we added here since the web editor doesn't look like it'd need that right?

Copy link
Member

@oandregal oandregal May 14, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, prepared #31819 to add a mobile context.

'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'block-editor-global-styles-settings-item',
'title' => 'block-editor-settings-item',
'type' => 'object',
'properties' => array(
'colors' => array(
'description' => __( 'Active theme colors.', 'gutenberg' ),
'type' => 'array',
'context' => array( 'view' ),
),

'gradients' => array(
'description' => __( 'Active theme gradients.', 'gutenberg' ),
'type' => 'array',
'__experimentalFeatures' => array(
'description' => __( 'Active theme settings and default values.', 'gutenberg' ),
'type' => 'object',
'context' => array( 'view' ),
),

'globalStyles' => array(
'description' => __( 'Theme support for global styles.', 'gutenberg' ),
'isFSETheme' => array(
'description' => __( 'Theme support for full site editing.', 'gutenberg' ),
'type' => 'boolean',
'context' => array( 'view' ),
),

'globalStylesUserEntityId' => array(
'description' => __( 'User entity id for Global styles settings.', 'gutenberg' ),
'type' => 'integer',
'context' => array( 'view' ),
),

'globalStylesBaseStyles' => array(
'__experimentalGlobalStylesBaseStyles' => array(
'description' => __( 'Global styles settings.', 'gutenberg' ),
'type' => 'object',
'context' => array( 'view' ),
Expand Down
45 changes: 6 additions & 39 deletions lib/global-styles.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,8 @@ function gutenberg_experimental_global_styles_settings( $settings ) {
unset( $settings['fontSizes'] );
unset( $settings['gradients'] );

$origin = 'theme';
$is_rest_request = defined( 'REST_REQUEST' ) && REST_REQUEST;
$origin = 'theme';
if (
WP_Theme_JSON_Resolver::theme_has_support() &&
gutenberg_is_fse_theme()
Expand All @@ -218,11 +219,12 @@ function gutenberg_experimental_global_styles_settings( $settings ) {
// In the site editor, the user can change styles, so the client
// needs the ability to create them. Hence, we pass it some data
// for this: base styles (core+theme) and the ID of the user CPT.
$screen = get_current_screen();
$screen = ! $is_rest_request ? get_current_screen() : null;
if (
! empty( $screen ) &&
( ( ! empty( $screen ) &&
function_exists( 'gutenberg_is_edit_site_page' ) &&
gutenberg_is_edit_site_page( $screen->id ) &&
gutenberg_is_edit_site_page( $screen->id ) ||
$is_rest_request ) ) &&
WP_Theme_JSON_Resolver::theme_has_support() &&
gutenberg_is_fse_theme()
) {
Expand Down Expand Up @@ -250,40 +252,6 @@ function_exists( 'gutenberg_is_edit_site_page' ) &&
return $settings;
}

/**
* Adds the necessary data of Global Styles for the REST API.
*
* @param array $settings Existing block editor settings.
* @return array New block editor settings
*/
function gutenberg_global_styles_rest_settings( $settings ) {
$color_palette = current( (array) get_theme_support( 'editor-color-palette' ) );
if ( false !== $color_palette ) {
$settings['colors'] = $color_palette;
}

$gradient_presets = current( (array) get_theme_support( 'editor-gradient-presets' ) );
if ( false !== $gradient_presets ) {
$settings['gradients'] = $gradient_presets;
}

$settings['globalStyles'] = WP_Theme_JSON_Resolver::theme_has_support();

if (
WP_Theme_JSON_Resolver::theme_has_support() &&
gutenberg_is_fse_theme()
) {
$theme_support_data = gutenberg_experimental_global_styles_get_theme_support_settings( $settings );
$user_cpt_id = WP_Theme_JSON_Resolver::get_user_custom_post_type_id();
$base_styles = WP_Theme_JSON_Resolver::get_merged_data( $theme_support_data, 'theme' )->get_raw_data();

$settings['globalStylesUserEntityId'] = $user_cpt_id;
$settings['globalStylesBaseStyles'] = $base_styles;
}

return $settings;
}

/**
* Register CPT to store/access user data.
*
Expand All @@ -299,7 +267,6 @@ function gutenberg_experimental_global_styles_register_user_cpt() {

add_action( 'init', 'gutenberg_experimental_global_styles_register_user_cpt' );
add_filter( 'block_editor_settings', 'gutenberg_experimental_global_styles_settings', PHP_INT_MAX );
add_filter( 'block_editor_global_styles_rest_settings', 'gutenberg_global_styles_rest_settings', PHP_INT_MAX );
add_action( 'wp_enqueue_scripts', 'gutenberg_experimental_global_styles_enqueue_assets' );


Expand Down
4 changes: 2 additions & 2 deletions lib/load.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ 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_Global_Styles_Settings_Controller' ) ) {
require_once dirname( __FILE__ ) . '/class-wp-rest-block-editor-global-styles-settings-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
Expand Down
8 changes: 4 additions & 4 deletions lib/rest-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,13 @@ function gutenberg_register_batch_endpoint() {
add_action( 'rest_api_init', 'gutenberg_register_batch_endpoint' );

/**
* Registers the Block types REST API routes.
* Registers the Block editor settings REST API routes.
*/
function gutenberg_register_block_editor_global_styles_settings() {
$editor_settings = new WP_REST_Block_Editor_Global_Styles_Settings_Controller();
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_global_styles_settings' );
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.
Expand Down