mirrored from git://develop.git.wordpress.org/
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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.
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
Update: Backport block settings to core. #4013
Closed
jorgefilipecosta
wants to merge
1
commit into
WordPress:trunk
from
jorgefilipecosta:update/backport-block-settings-to-core
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
<?php | ||
/** | ||
* Block level presets support. | ||
* | ||
* @package WordPress | ||
* @since 6.2.0 | ||
*/ | ||
|
||
/** | ||
* Get the class name used on block level presets. | ||
* | ||
* @internal | ||
* | ||
* @since 6.2.0 | ||
* @access private | ||
* | ||
* @param array $block Block object. | ||
* @return string The unique class name. | ||
*/ | ||
function _wp_get_presets_class_name( $block ) { | ||
return 'wp-settings-' . md5( serialize( $block ) ); | ||
} | ||
|
||
/** | ||
* Update the block content with block level presets class name. | ||
* | ||
* @internal | ||
* | ||
* @since 6.2.0 | ||
* @access private | ||
* | ||
* @param string $block_content Rendered block content. | ||
* @param array $block Block object. | ||
* @return string Filtered block content. | ||
*/ | ||
function _wp_add_block_level_presets_class( $block_content, $block ) { | ||
if ( ! $block_content ) { | ||
return $block_content; | ||
} | ||
|
||
// return early if the block doesn't have support for settings. | ||
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] ); | ||
if ( ! block_has_support( $block_type, array( '__experimentalSettings' ), false ) ) { | ||
return $block_content; | ||
} | ||
|
||
// return early if no settings are found on the block attributes. | ||
$block_settings = _wp_array_get( $block, array( 'attrs', 'settings' ), null ); | ||
if ( empty( $block_settings ) ) { | ||
return $block_content; | ||
} | ||
|
||
// Like the layout hook this assumes the hook only applies to blocks with a single wrapper. | ||
// Add the class name to the first element, presuming it's the wrapper, if it exists. | ||
$tags = new WP_HTML_Tag_Processor( $block_content ); | ||
if ( $tags->next_tag() ) { | ||
$tags->add_class( _wp_get_presets_class_name( $block ) ); | ||
} | ||
|
||
return $tags->get_updated_html(); | ||
} | ||
|
||
/** | ||
* Render the block level presets stylesheet. | ||
* | ||
* @internal | ||
* | ||
* @since 6.2.0 | ||
* @access private | ||
* | ||
* @param string|null $pre_render The pre-rendered content. Default null. | ||
* @param array $block The block being rendered. | ||
* | ||
* @return null | ||
*/ | ||
function _wp_add_block_level_preset_styles( $pre_render, $block ) { | ||
// Return early if the block has not support for descendent block styles. | ||
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] ); | ||
if ( ! block_has_support( $block_type, array( '__experimentalSettings' ), false ) ) { | ||
return null; | ||
} | ||
|
||
// return early if no settings are found on the block attributes. | ||
$block_settings = _wp_array_get( $block, array( 'attrs', 'settings' ), null ); | ||
if ( empty( $block_settings ) ) { | ||
return null; | ||
} | ||
|
||
$class_name = '.' . _wp_get_presets_class_name( $block ); | ||
|
||
// the root selector for preset variables needs to target every possible block selector | ||
// in order for the general setting to override any bock specific setting of a parent block or | ||
// the site root. | ||
$variables_root_selector = '*,[class*="wp-block"]'; | ||
$registry = WP_Block_Type_Registry::get_instance(); | ||
$blocks = $registry->get_all_registered(); | ||
foreach ( $blocks as $block_type ) { | ||
if ( | ||
isset( $block_type->supports['__experimentalSelector'] ) && | ||
is_string( $block_type->supports['__experimentalSelector'] ) | ||
) { | ||
$variables_root_selector .= ',' . $block_type->supports['__experimentalSelector']; | ||
} | ||
} | ||
$variables_root_selector = WP_Theme_JSON::scope_selector( $class_name, $variables_root_selector ); | ||
|
||
// Remove any potentially unsafe styles. | ||
$theme_json_shape = WP_Theme_JSON::remove_insecure_properties( | ||
array( | ||
'version' => WP_Theme_JSON::LATEST_SCHEMA, | ||
'settings' => $block_settings, | ||
) | ||
); | ||
$theme_json_object = new WP_Theme_JSON( $theme_json_shape ); | ||
|
||
$styles = ''; | ||
|
||
// include preset css variables declaration on the stylesheet. | ||
$styles .= $theme_json_object->get_stylesheet( | ||
array( 'variables' ), | ||
null, | ||
array( | ||
'root_selector' => $variables_root_selector, | ||
'scope' => $class_name, | ||
) | ||
); | ||
|
||
// include preset css classes on the the stylesheet. | ||
$styles .= $theme_json_object->get_stylesheet( | ||
array( 'presets' ), | ||
null, | ||
array( | ||
'root_selector' => $class_name . ',' . $class_name . ' *', | ||
'scope' => $class_name, | ||
) | ||
); | ||
|
||
if ( ! empty( $styles ) ) { | ||
wp_enqueue_block_support_styles( $styles ); | ||
} | ||
|
||
return null; | ||
} | ||
|
||
add_filter( 'render_block', '_wp_add_block_level_presets_class', 10, 2 ); | ||
add_filter( 'pre_render_block', '_wp_add_block_level_preset_styles', 10, 2 ); |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The method will be deprecated in favor of
wp_style_engine_get_stylesheet_from_css_rules
. See #4015.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tested using the recommended method: it didn't work or I didn't know how to use it. It's best to look at this separately in a follow-up.