-
Notifications
You must be signed in to change notification settings - Fork 3k
Extend conditional loading of block global styles to third-party blocks #9413
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
Open
Ref34t
wants to merge
3
commits into
WordPress:trunk
Choose a base branch
from
Ref34t:improvement/global-styles-third-party-blocks
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+56
−14
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 hidden or 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 |
---|---|---|
|
@@ -243,6 +243,37 @@ function wp_get_global_stylesheet( $types = array() ) { | |
return $stylesheet; | ||
} | ||
|
||
/** | ||
* Generate the stylesheet handle for a block. | ||
* | ||
* @since 6.9.0 | ||
* @access private | ||
* | ||
* @param string $block_name The block name (e.g., 'core/paragraph' or 'my-plugin/custom-block'). | ||
* @return string|null The stylesheet handle or null if generation fails. | ||
*/ | ||
function wp_generate_block_stylesheet_handle( $block_name ) { | ||
if ( ! is_string( $block_name ) || empty( $block_name ) ) { | ||
return null; | ||
} | ||
|
||
// Handle core blocks. | ||
if ( str_starts_with( $block_name, 'core/' ) ) { | ||
$block_name = str_replace( 'core/', '', $block_name ); | ||
return 'wp-block-' . $block_name; | ||
} | ||
|
||
// Handle third-party blocks. | ||
$block_name_parts = explode( '/', $block_name ); | ||
if ( count( $block_name_parts ) === 2 && ! empty( $block_name_parts[0] ) && ! empty( $block_name_parts[1] ) ) { | ||
$namespace = $block_name_parts[0]; | ||
$name = $block_name_parts[1]; | ||
return 'wp-block-' . $namespace . '-' . $name; | ||
} | ||
|
||
return null; | ||
} | ||
|
||
/** | ||
* Adds global style rules to the inline style for each block. | ||
* | ||
|
@@ -312,33 +343,44 @@ function wp_add_global_styles_for_blocks() { | |
* Block-specific global styles should be attached to the global-styles handle, but | ||
* only for blocks on the page, thus we check if the block's handle is in the queue | ||
* before adding the inline style. | ||
* This conditional loading only applies to core blocks. | ||
* TODO: Explore how this could be expanded to third-party blocks as well. | ||
* This conditional loading applies to both core and third-party blocks. | ||
*/ | ||
if ( isset( $metadata['name'] ) ) { | ||
if ( str_starts_with( $metadata['name'], 'core/' ) ) { | ||
$block_name = str_replace( 'core/', '', $metadata['name'] ); | ||
$block_handle = 'wp-block-' . $block_name; | ||
if ( in_array( $block_handle, $wp_styles->queue, true ) ) { | ||
$block_handle = wp_generate_block_stylesheet_handle( $metadata['name'] ); | ||
|
||
if ( $block_handle && in_array( $block_handle, $wp_styles->queue, true ) ) { | ||
wp_add_inline_style( $stylesheet_handle, $block_css ); | ||
} elseif ( ! $block_handle ) { | ||
// Fallback for blocks with unexpected naming patterns. | ||
wp_add_inline_style( $stylesheet_handle, $block_css ); | ||
} else { | ||
// For third-party blocks, load styles if the block handle was generated successfully | ||
// but not found in queue. This maintains backward compatibility where third-party | ||
// block styles were always loaded. | ||
if ( ! str_starts_with( $metadata['name'], 'core/' ) ) { | ||
wp_add_inline_style( $stylesheet_handle, $block_css ); | ||
} | ||
} else { | ||
wp_add_inline_style( $stylesheet_handle, $block_css ); | ||
} | ||
} | ||
|
||
// The likes of block element styles from theme.json do not have $metadata['name'] set. | ||
if ( ! isset( $metadata['name'] ) && ! empty( $metadata['path'] ) ) { | ||
$block_name = wp_get_block_name_from_theme_json_path( $metadata['path'] ); | ||
if ( $block_name ) { | ||
if ( str_starts_with( $block_name, 'core/' ) ) { | ||
$block_name = str_replace( 'core/', '', $block_name ); | ||
$block_handle = 'wp-block-' . $block_name; | ||
if ( in_array( $block_handle, $wp_styles->queue, true ) ) { | ||
$block_handle = wp_generate_block_stylesheet_handle( $block_name ); | ||
|
||
if ( $block_handle && in_array( $block_handle, $wp_styles->queue, true ) ) { | ||
wp_add_inline_style( $stylesheet_handle, $block_css ); | ||
} elseif ( ! $block_handle ) { | ||
// Fallback for blocks with unexpected naming patterns. | ||
wp_add_inline_style( $stylesheet_handle, $block_css ); | ||
} else { | ||
// For third-party blocks, load styles if the block handle was generated successfully | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This multiline comment doesn't follow documentation guidelines. |
||
// but not found in queue. This maintains backward compatibility where third-party | ||
// block styles were always loaded. | ||
if ( ! str_starts_with( $block_name, 'core/' ) ) { | ||
wp_add_inline_style( $stylesheet_handle, $block_css ); | ||
} | ||
} else { | ||
wp_add_inline_style( $stylesheet_handle, $block_css ); | ||
} | ||
} | ||
} | ||
|
Oops, something went wrong.
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.
this function performs a lot of work, but is it doing anything other than replacing the slash with a dash?
Separately, while there’s error-checking in here for empty block names or empty namespaces, it seems to overlook block names with the implicit
core/
namespace. Currently I believe it returnsnull
for those. If it’s providedparagraph
should it returnnull
orwp-block-paragraph
?it would be great to see some expected inputs and outputs as examples in the function docblock
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.
Great points, @dmsnell! You're absolutely right on both counts.
-Re: "more than replacing slash with dash"
You're correct - the function name undersells what it's actually doing. It's performing namespace normalization (stripping
core/
), character replacement, and CSS class generation. The complexity could be better reflected in either the function name or documentation.-Re: core namespace handling
Good catch on the implicit core namespace issue. Looking at the current logic, I believe both cases should work correctly:
'paragraph'
→'wp-block-paragraph'
(no change from str_replace)'core/paragraph'
→'wp-block-paragraph'
(core/ stripped)However, the
return null;
on line 274 suggests there might be additional validation logic that's causing issues with certain block names. Could you share a specific example where'paragraph'
returns null? That would help identify if there's a validation condition I'm missing.Re: documentation
Absolutely agree on adding examples to the docblock. Something like:
Would also be worth optimizing for the common case where no namespace is present (avoiding unnecessary string operations).
Let me know if you can provide more details on the null return case - happy to investigate further!