wordpress-develop icon indicating copy to clipboard operation
wordpress-develop copied to clipboard

Prime cache for salting options. (ALT)

Open peterwilsoncc opened this issue 1 year ago • 3 comments

Use the wp_prime_site_option_caches() function to prime options containing the various salts in a single database query.

I'd really like to add some tests for these but am not able to as the salts are cached in a static withing wp_salt and by the time the test is run they will have been added to the static elsewhere.

https://github.com/WordPress/wordpress-develop/blob/5706a203849740ab4479136e5fd22803f942f5ef/src/wp-includes/pluggable.php#L2425-L2437

I did test these locally with the code in this gist and it worked as expected when running the following commands:

./vendor/bin/phpunit --filter Tests_Pluggable_wp_salt -c tests/phpunit/multisite.xml
./vendor/bin/phpunit --filter Tests_Pluggable_wp_salt

Given the static exists, it could be worth bypassing these changes if ! empty( $cached_salts ) but I am not sure how much of an advantage that offers.

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


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.

peterwilsoncc avatar Jun 04 '24 00:06 peterwilsoncc

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @jonnynews.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Props peterwilsoncc, spacedmonkey.

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

github-actions[bot] avatar Jun 04 '24 00:06 github-actions[bot]

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.

github-actions[bot] avatar Jun 04 '24 00:06 github-actions[bot]

@spacedmonkey I've pushed a change to also prime the secret_key option if we're priming other options. It's not generally used as best I can tell (only if the scheme is invalid).

peterwilsoncc avatar Jul 22 '24 05:07 peterwilsoncc

Merged r58837 / https://github.com/WordPress/wordpress-develop/commit/74e03e3cbef2f2565028f446c76acb2dabf749bd

peterwilsoncc avatar Jul 31 '24 22:07 peterwilsoncc