Create block: Update template to use new performance tools for blocks coming in 6.7 #66485
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
ryanwelcher
added
[Type] Enhancement
ryanwelcher
changed the title
|
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. |
|
Size Change: 0 B Total Size: 1.81 MB ℹ️ View Unchanged
|
gziolo
reviewed
Oct 28, 2024
| @@ -42,6 +42,14 @@ if ( ! defined( 'ABSPATH' ) ) { | |||
| * @see https://developer.wordpress.org/reference/functions/register_block_type/ | |||
| */ | |||
| function {{namespaceSnakeCase}}_{{slugSnakeCase}}_block_init() { | |||
|
|
|||
| // Register the block metadata. | |||
| wp_register_block_metadata_collection( | |||
There was a problem hiding this comment.
This method will exist only in WordPress 6.7 so we would have to call it conditionally as long as the minimum required version for WP is set to 6.6.
By the way, @felixarntz opened a proposal https://core.trac.wordpress.org/ticket/62267 to add an option to this function to automatically register blocks listed in the manifest file. With that, we would no longer need to add register_block_type( __DIR__ . '/build' ); for every block type included in the plugin. Eventually (WordPress 6.8?), the following should become the only code required no matter how many block types the plugin contains:
// Registers the block types metadata.
wp_register_block_metadata_collection(
__DIR__ . '/build'
__DIR__ . '/build/blocks-manifest.php',
array( 'auto_register' => true )
);There was a problem hiding this comment.
This method will exist only in WordPress 6.7 so we would have to call it conditionally as long as the minimum required version for WP is set to 6.6.
I'm sorry, I had added a check but didn't push up the changes. I went with a simple function_exists call.
With that, we would no longer need to add register_block_type( DIR . '/build' ); for every block type included in the plugin.
That would be amazing. It's pretty easy to forget to go back and add that line for a new block.
ryanwelcher
changed the title
|
Flaky tests detected in 9bbaa31. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11555971110
|
|
I need to investigate it further to understand better what happens when the block is located directly in the 
In effect, the manifest with block metadata puts the key for the block as 
Edit: I was wondering if that correctly loads the metadata from the cache file. It turns out that when I remove
|
gziolo
reviewed
Oct 29, 2024
Co-authored-by: Greg Ziółkowski <[email protected]>
|
There are two findings I have after playing with
|
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.
What?
This PR adds the new
wp_register_block_metadata_collection()function and associatednpmcommands to the standard template forcreate-block.I've wrapped the
wp_register_block_metadata_collectionin afunction_existscheck so this could be merged before 6.7. but it's probably better to merge after it's releasedCloses #66484
Why?
Performance improvements are a good thing and by adding this to the template to new scaffolded blocks, extenders will get the benefits for all new blocks.
Testing Instructions
packages/create-blocknode index.js new-blocknew-block.phpfilebuild-blocks-manifestcommand and apostbuildcommand that references it.