Changeset 57016

Timestamp:

10/27/2023 12:00:15 AM (12 months ago)

Author:

peterwilsoncc

Message:

Options, Meta APIs: Rename option cache priming functions.

Rename the option cache priming functions to more closely follow the naming convention used by other cache priming functions.

• wp_load_options() becomes wp_prime_option_caches()
• wp_load_options_by_group() becomes wp_prime_option_caches_by_group()

The unit test files and classes are renamed accordingly.

Unlike the existing cache priming functions, these functions were introduced with the intention of being public so use the wp_ prefix rather than the _ prefix used by the functions initially introduced as private functions but since made public.

Follow up to [56445],[56990].

Props flixos90, peterwilsoncc, joemcgill, SergeyBiryukov, desrosj.
Reviewed by flixos90.
Merges [57013] to the 6.4 branch.
Fixes #58962.

Location:

branches/6.4

Files:

• . (modified) (1 prop)
• src/wp-includes/option.php (modified) (5 diffs)
• tests/phpunit/tests/option/wpLoadOptions.php (deleted)
• tests/phpunit/tests/option/wpLoadOptionsByGroup.php (deleted)
• tests/phpunit/tests/option/wpPrimeOptionCaches.php (copied) (copied from trunk/tests/phpunit/tests/option/wpPrimeOptionCaches.php)
• tests/phpunit/tests/option/wpPrimeOptionCachesByGroup.php (copied) (copied from trunk/tests/phpunit/tests/option/wpPrimeOptionCachesByGroup.php)

branches/6.4/src/wp-includes/option.php

@@ -249 +249 @@
 
 /**
- * Loads specific options into the cache with a single database query.
+ * Primes specific options into the cache with a single database query.
  *
  * Only options that do not already exist in cache will be loaded.
@@ -259 +259 @@
  * @param array $options An array of option names to be loaded.
  */
-function wp_load_options( $options ) {
+function wp_prime_option_caches( $options ) {
     $alloptions     = wp_load_alloptions();
     $cached_options = wp_cache_get_multiple( $options, 'options' );
@@ -322 +322 @@
 
 /**
- * Loads all options registered with a specific option group.
+ * Primes the cache of all options registered with a specific option group.
  *
  * @since 6.4.0
@@ -330 +330 @@
  * @param string $option_group The option group to load options for.
  */
-function wp_load_options_by_group( $option_group ) {
+function wp_prime_option_caches_by_group( $option_group ) {
     global $new_allowed_options;
 
     if ( isset( $new_allowed_options[ $option_group ] ) ) {
-        wp_load_options( $new_allowed_options[ $option_group ] );
+        wp_prime_option_caches( $new_allowed_options[ $option_group ] );
     }
 }
@@ -349 +349 @@
  */
 function get_options( $options ) {
-    wp_load_options( $options );
+    wp_prime_option_caches( $options );
 
     $result = array();