Reuse block metadata in `WP_Theme_JSON::get_valid_block_style_variations()` for better performance #7586

mukeshpanchal27 · 2024-10-18T07:07:17Z

Trac Ticket: https://core.trac.wordpress.org/ticket/62291

github-actions · 2024-10-18T07:20:46Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

mukeshpanchal27 · 2024-10-21T04:33:02Z

Before:

After:

mukeshpanchal27 · 2024-10-24T05:26:08Z

@joemcgill @ramonjd Please review when you have moment. Thanks

ramonjd · 2024-10-24T05:36:40Z

This change makes sense to me. Good idea to reduce the calls to get_blocks_metadata(), which preserving backwards compatibility.

I did a quick sweep for other instances of get_valid_block_style_variations and couldn't find any.

github-actions · 2024-10-24T06:35:06Z

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props mukesh27, flixos90, ramonopoly, aaronrobertshaw.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

src/wp-includes/class-wp-theme-json.php

felixarntz · 2024-10-24T13:52:34Z

src/wp-includes/class-wp-theme-json.php

+	protected static function get_valid_block_style_variations( $blocks_metadata = array() ) {
 		$valid_variations = array();
-		foreach ( self::get_blocks_metadata() as $block_name => $block_meta ) {


Maybe we should still call self::get_blocks_metadata() in case no value was provided, i.e. as default?

Since this method is protected (not private), in theory someone else could have overwritten this class. Highly unlikely but possible. Additionally though, not requiring the parameter makes using the method more ergonomic in situations where it hasn't been computed before.

I already added $blocks_metadata = empty( $blocks_metadata ) ? static::get_blocks_metadata() : $blocks_metadata; if the value is not passed of empty.

Let me know if i missed anything.

src/wp-includes/class-wp-theme-json.php

Co-authored-by: Felix Arntz <[email protected]>

ramonjd

LGTM. Smoke tested locally. Tests pass and logs are clean.

Thanks!

Let me know if you need help backporting to the plugin.

mukeshpanchal27 · 2024-10-28T04:23:06Z

Let me know if you need help backporting to the plugin.

Yes please if you have moment. Thanks

…ress-develop#7586

ramonjd · 2024-10-28T22:51:18Z

Gutenberg backport PR:

Block Style Variations: Reuse block metadata in WP_Theme_JSON::get_valid_block_style_variations() for better performance gutenberg#66539

aaronrobertshaw

I've given this one a quick test as well. LGTM too.

As part of the testing I also ran through the various means of defining block style variations (theme.json partials, register_block_style etc). All the variations displayed correctly, could be modified in global styles, and had updates reflected appropriately on the frontend.

LGTM too.

I'll give the plugin backport a run shortly.

…block_style_variations() for better performance (#66539) * Backporting theme json performance optimizations from WordPress/wordpress-develop#7586 * Tentatively backport using `get_blocks_metadata` instead of `WP_Block_Type_Registry` to get block names. Co-authored-by: ramonjd <[email protected]> Co-authored-by: mukeshpanchal27 <[email protected]> Co-authored-by: aaronrobertshaw <[email protected]>

…block_style_variations() for better performance (#66539) * Backporting theme json performance optimizations from WordPress/wordpress-develop#7586 * Tentatively backport using `get_blocks_metadata` instead of `WP_Block_Type_Registry` to get block names. Co-authored-by: ramonjd <[email protected]> Co-authored-by: mukeshpanchal27 <[email protected]> Co-authored-by: aaronrobertshaw <[email protected]> Source: WordPress/gutenberg@828868d

ramonjd · 2024-11-04T23:54:18Z

Is this ready to be committed? The Gutenberg backport PR is merged.

mukeshpanchal27 · 2024-11-05T04:57:13Z

Is this ready to be committed? The Gutenberg backport PR is merged.

Yes. If you have moment then commit it.

ramonjd · 2024-11-06T00:43:36Z

Committed in r59359 / 5ff9717

…block_style_variations() for better performance (WordPress#66539) * Backporting theme json performance optimizations from WordPress/wordpress-develop#7586 * Tentatively backport using `get_blocks_metadata` instead of `WP_Block_Type_Registry` to get block names. Co-authored-by: ramonjd <[email protected]> Co-authored-by: mukeshpanchal27 <[email protected]> Co-authored-by: aaronrobertshaw <[email protected]>

Performance assessment for get_valid_block_style_variations()

0cde12a

mukeshpanchal27 requested review from ramonjd and joemcgill October 21, 2024 04:42

mukeshpanchal27 changed the title ~~Performance assessment for WP_Theme_JSON~~ Performance assessment: Reduce WP_Theme_JSON::get_blocks_metadata() calls Oct 24, 2024

Merge branch 'WordPress:trunk' into fix/performance-improvement

522d5b9

mukeshpanchal27 changed the title ~~Performance assessment: Reduce WP_Theme_JSON::get_blocks_metadata() calls~~ Reuse block metadata in WP_Theme_JSON::get_valid_block_style_variations() for better performance Oct 24, 2024

mukeshpanchal27 marked this pull request as ready for review October 24, 2024 06:34

mukeshpanchal27 requested a review from felixarntz October 24, 2024 06:50

mukeshpanchal27 commented Oct 24, 2024

View reviewed changes

src/wp-includes/class-wp-theme-json.php Outdated Show resolved Hide resolved

Add version number

50ea742

felixarntz reviewed Oct 24, 2024

View reviewed changes

Accept docblock suggestion

2e149fd

Co-authored-by: Felix Arntz <[email protected]>

ramonjd approved these changes Oct 27, 2024

View reviewed changes

mukeshpanchal27 requested a review from felixarntz October 28, 2024 04:05

ramonjd added a commit to WordPress/gutenberg that referenced this pull request Oct 28, 2024

Backporting theme json performance optimizations from WordPress/wordp…

9a95cd2

…ress-develop#7586

ramonjd mentioned this pull request Oct 29, 2024

Block Style Variations: Reuse block metadata in WP_Theme_JSON::get_valid_block_style_variations() for better performance WordPress/gutenberg#66539

Merged

aaronrobertshaw approved these changes Oct 29, 2024

View reviewed changes

mukeshpanchal27 self-assigned this Nov 4, 2024

ramonjd closed this Nov 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reuse block metadata in `WP_Theme_JSON::get_valid_block_style_variations()` for better performance #7586

Reuse block metadata in `WP_Theme_JSON::get_valid_block_style_variations()` for better performance #7586

mukeshpanchal27 commented Oct 18, 2024 •

edited

Loading

github-actions bot commented Oct 18, 2024

mukeshpanchal27 commented Oct 21, 2024

mukeshpanchal27 commented Oct 24, 2024

ramonjd commented Oct 24, 2024

github-actions bot commented Oct 24, 2024 •

edited

Loading

felixarntz Oct 24, 2024

mukeshpanchal27 Oct 25, 2024

ramonjd left a comment

mukeshpanchal27 commented Oct 28, 2024

ramonjd commented Oct 28, 2024

aaronrobertshaw left a comment

ramonjd commented Nov 4, 2024

mukeshpanchal27 commented Nov 5, 2024

ramonjd commented Nov 6, 2024

Reuse block metadata in WP_Theme_JSON::get_valid_block_style_variations() for better performance #7586

Reuse block metadata in WP_Theme_JSON::get_valid_block_style_variations() for better performance #7586

Conversation

mukeshpanchal27 commented Oct 18, 2024 • edited Loading

github-actions bot commented Oct 18, 2024

Test using WordPress Playground

Some things to be aware of

mukeshpanchal27 commented Oct 21, 2024

Before:

After:

mukeshpanchal27 commented Oct 24, 2024

ramonjd commented Oct 24, 2024

github-actions bot commented Oct 24, 2024 • edited Loading

felixarntz Oct 24, 2024

Choose a reason for hiding this comment

mukeshpanchal27 Oct 25, 2024

Choose a reason for hiding this comment

ramonjd left a comment

Choose a reason for hiding this comment

mukeshpanchal27 commented Oct 28, 2024

ramonjd commented Oct 28, 2024

aaronrobertshaw left a comment

Choose a reason for hiding this comment

ramonjd commented Nov 4, 2024

mukeshpanchal27 commented Nov 5, 2024

ramonjd commented Nov 6, 2024

Reuse block metadata in `WP_Theme_JSON::get_valid_block_style_variations()` for better performance #7586

Reuse block metadata in `WP_Theme_JSON::get_valid_block_style_variations()` for better performance #7586

mukeshpanchal27 commented Oct 18, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading