(WIP) Add a new endpoint that exposes block editor settings through the REST API #25226
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tug
added
[Status] In Progress
Tug
added
the
Mobile App - i.e. Android or iOS
|
Size Change: +1.59 kB (0%) Total Size: 1.39 MB
ℹ️ View Unchanged
|
TimothyBJacobs
added
Core REST API Task
|
Ideally this would have a schema documenting the response format. Is the block editor settings array structured enough to support that? |
|
@TimothyBJacobs Good question! I don't have a precise answer for it right now. Afaik "editor settings" on the client is currently defined by its default value. |
|
This endpoint should be preloaded on the page. |
InfiniteLove2020
approved these changes
Sep 15, 2020
oandregal
added
the
Global Styles
# Conflicts: # lib/global-styles.php # lib/load.php # lib/rest-api.php
geriux
changed the title
chipsnyder
reviewed
Mar 1, 2021
Comment on lines
43
to
49
| * @since 5.5.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 ) { |
There was a problem hiding this comment.
@geriux I think You might still need this when I pull in this commit I get:
Warning: Declaration of WP_REST_Block_Editor_Settings_Controller::get_items() should be compatible with WP_REST_Controller::get_items($request) in /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php on line 59 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-includes/functions.php on line 6362 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-admin/includes/misc.php on line 1310 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-admin/admin-header.php on line 9 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-includes/option.php on line 1051 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-includes/option.php on line 1052
| * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. | ||
| */ | ||
| public function get_items( $request ) { |
There was a problem hiding this comment.
@geriux I think You might still need this when I pull in this commit I get:
Warning: Declaration of WP_REST_Block_Editor_Settings_Controller::get_items() should be compatible with WP_REST_Controller::get_items($request) in /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php on line 59 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-includes/functions.php on line 6362 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-admin/includes/misc.php on line 1310 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-admin/admin-header.php on line 9 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-includes/option.php on line 1051 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/gutenberg/lib/class-wp-rest-block-editor-settings-controller.php:0) in /var/www/html/wp-includes/option.php on line 1052
|
Closing in favor of #29969 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This new endpoint at
/__experimental/block-editor-settingswill return all the current settings for the block editor. This will be especially useful for the mobile block editor to set up the GSS (Global Style System) and may even be used to load block patterns.This is a WIP and will need to be discussed first.
How has this been tested?
Untested code right now!
Types of changes
New core REST API endpoint
Checklist: