-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Add pre 6.5 compat for viewStyles #59322
Conversation
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @chimok. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. 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. |
wordpress-playground.zip |
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
That was very helpful as I was able to confirm everything works as expected with WP 6.4 using my phone 🎉 I'll review the code later but overall it should be in good shape already. Thank you for adding the compat layer. |
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.
9402353
to
89b36b7
Compare
@gziolo Thanks, just pushed a commit with the feedback applied 👍 |
* Add pre 6.5 compat for viewStyles * docblock feedback Unlinked contributors: chimok. Co-authored-by: gaambo <gaambo@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org>
What?
Closes #54491.
This is a follow-up to #55492 and the related commit in core. It provides support for the new
viewStyle
block metadata property to sites running core versions < 6.5 but the newest Gutenberg version.Why?
Since the Gutenberg plugin should provide support for the two latest WordPress versions and the code in the Gutenberg repository has the documentation about the new property, it may makes sense to also provide this functionality to sites running older core versions but the newest plugin.
The same thing was done for the
viewModules
field in #57437.This also allows core blocks to use the new viewStyle field in the future and makes it work on older core sites as well.
How?
The code just directly copies what core does in 6.5+. Unfortunately the functions
register_block_style_handle
andgenerate_block_asset_handle
had to be copied and changed, because otherwise the new postfix (view-style
) would not have been appended or the style handle name would be wrong.The handles are generated/registered on
block_type_metadata_settings
(just like in core) and enqueued onrender_block
(just like core).The field has also been added to the rest api.
Testing Instructions
To test this, use the gutenberg plugin on a WordPress 6.4/6.3 instance (eg locally by using
.wp-env.override.json
and adding"core": "WordPress/WordPress#6.4",
).Original testing instructions:
I've created a simple test block which uses the new property here: https://github.com/gaambo/test-block-viewStyle
You can't check the network tab in developer tools for loaded assets, since both are so small and are inlined.
Alternative: Use your custom block and add a viewStyle property in block.json. The property has the same schema as style and editorStyle - so a singular string or array is allowed and style handles as well as file: links to files. See the test block repository above for an example.