Block Styles: Add extended version of register block style functions #61029
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
aaronrobertshaw
added
[Type] Enhancement
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
youknowriad
reviewed
Apr 24, 2024
In core, register_block_style only allows registering a style for a single block. The PR allows registering the same style for multiple blocks. |
|
Ah makes sense, maybe let's add a very small unit test (to be brought to Core later) |
|
I see that the |
youknowriad
approved these changes
Apr 24, 2024
This version allows you to pass an array of block types to register a single block style for, instead of having to call Originally, this version also explicitly handled when As the block style variations feature evolved, that approach didn't work for applying variations within blocks that have other variations already applied. In #57908, the theme.json resolver takes any So long story, short, what we're left with is the requirement that theme authors could register a style across multiple blocks at once e.g. #56234 (comment). |
|
I was a bit slow with my reply 🐢 Hopefully, the extra context helps for posterity as well as explaining the new Edit: For the record, if this is merged before the related changes for #57908, the |
|
Will this also be added to the Javascript version of the API? If so, this will close #50256 |
|
I've had a go at updating the JS side of the block style registration in ba8c647. It would be great to get a sanity check there and make sure there isn't a better approach. I did look at batching the dispatched actions in Happy to change tack if needed 🙂 |
|
Size Change: +40 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
aaronrobertshaw
changed the title
|
What's blocking this PR. Anything you need help with? |
scruffian
force-pushed
the
add/gutenberg_register_block_style
branch
from
d628645 to
dba1d19
Compare
scruffian
reviewed
May 13, 2024
| const original = deepFreeze( {} ); | ||
|
|
||
| let state = blockStyles( original, { | ||
| type: 'ADD_BLOCK_STYLES', | ||
| blockName, | ||
| blockNames: [ blockName ], |
There was a problem hiding this comment.
Suggested change
| blockNames: [ blockName ], | |
| blockNames: blockName, |
I think we should test this with a string, to check it works both ways.
There was a problem hiding this comment.
Well this breaks the tests, so I guess we need to be sure to cast it to an array!
There was a problem hiding this comment.
Thanks for taking a look at this part of the PR 👍
I'm not sure we need to cover the possibility of someone dispatching their own action object for this. If they use addBlockStyles to create the action that will handle the casting any string given to an array.
Maybe I could actually use addBlockStyles within the tests here to sort of cover your suggestion?
There was a problem hiding this comment.
I've switched the tests to use addBlockStyles which illustrates the use case with a single block name as a string.
scruffian
approved these changes
May 13, 2024
This reverts commit 88deb8b.
aaronrobertshaw
force-pushed
the
add/gutenberg_register_block_style
branch
from
cf7ac41 to
9fac655
Compare
|
Thanks for the reviews and testing everyone 👍 I'll get this merged and address anything further in follow-ups. |
This was referenced May 23, 2024
|
Backport for these changes can be found in: WordPress/wordpress-develop#6609 |
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.
Related:
Note: The changes in this PR are being split out from #57908 to make that more manageable
What?
The
WP_Block_Styles_Registryclass was markedfinalso it can't be extended in Gutenberg to allow block styles to be registered across multiple block types or with a style data object.This PR adds a global function,
gutenberg_register_block_style, that will allow Gutenberg to support the extended block style registration until it is in Core and that version of WordPress is the minimum supported by Gutenberg.Additionally, the JS
registerBlockStylefunction has been updated to match i.e. you can pass it an array of block types to register the block style for.Why?
The planned section styling feature requires the ability to share block style variations across block types.
It is desired to allow registration of such block styles through both theme.json and the existing
register_block_stylePHP function. The proposed function here helps make this possible untilregister_block_stylecan be updated in core.Testing Instructions
stringblock name orarrayof block namesScreenshot