Skip to content
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

Improve theme file caching in class-wp-theme-json.php #6707

Closed
wants to merge 2 commits into from

Conversation

spacedmonkey
Copy link
Member

Minor changes have been made to class-wp-theme-json.php to better cache the theme files. This includes adding an 'update_cache' functionality that sets 'str_start_with' and 'str_start_with_cache', and removing redundant checks for empty or non-numerical values. These improvements aim to optimize performance by updating cache when necessary.

Trac ticket: https://core.trac.wordpress.org/ticket/59595


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Minor changes have been made to class-wp-theme-json.php to better cache the theme files. This includes adding an 'update_cache' functionality that sets 'str_start_with' and 'str_start_with_cache', and removing redundant checks for empty or non-numerical values. These improvements aim to optimize performance by updating cache when necessary.
Copy link

github-actions bot commented Jun 2, 2024

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 spacedmonkey, adamsilverstein, joemcgill, ellatrix.

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

Copy link

github-actions bot commented Jun 2, 2024

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.

The array-to-string conversion in the class-wp-theme-json.php file has been modified for more optimized performance. The original simple implode function has been replaced with a loop to more efficiently concatenate the array elements. This approach also gives more flexible control in handling the dot separator.
@joemcgill
Copy link
Member

Thanks @spacedmonkey. I did some profiling of this change against trunk and it does reduce the number of str_starts_with calls quite drastically.

Trunk
image

This PR
image

That said, the PR we've been working on has a bigger impact by reducing the number of calls to this method altogether. It may be worth combining both approaches to maximize the benefit, but I'd like to prioritize getting #6392 into trunk first as it has the biggest potential impact.

@joemcgill
Copy link
Member

@spacedmonkey are ok to close this in favor of WordPress/gutenberg#62522?

@ellatrix
Copy link
Member

@joemcgill This is the backport PR? We'll need both?

@joemcgill
Copy link
Member

@ellatrix and @spacedmonkey, it's fine to use this PR as the backport from WordPress/gutenberg#62522. At present, it's not the same code though, so this will need to be updated once the GB PR is finalized.

}

/*
* Look up protected properties, keyed by value path.
* Skip protected properties that are explicitly set to `null`.
*/
if ( is_array( $value_path ) ) {
$path_string = implode( '.', $value_path );
$path_string = '';
for ( $i = 0; $i < count( $value_path ); $i++ ) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this bit faster than the call to implode?

Copy link
Member

@adamsilverstein adamsilverstein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

Copy link
Member

@joemcgill joemcgill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marking as not ready until after this has been updated with the approach from WordPress/gutenberg#62522 (see related comment).

@joemcgill
Copy link
Member

@spacedmonkey, I've approved the related GB PR. Once this PR is updated to reflect the latest changes, I'm happy to give another review.

@spacedmonkey
Copy link
Member Author

Closing in favour of #6895

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
4 participants