Changeset 56990

Timestamp:

10/23/2023 09:27:31 PM (13 months ago)

Author:

flixos90

Message:

Options, Meta APIs: Rename prime_options() to wp_load_options().

This clearly separates these functions which are intended to be used by external developers from the existing _prime_*_caches() functions which are primarily intended for internal usage. The term "load" is additionally more accessible than "prime".

This changeset renames the above function, as well as the wrapper function prime_options_by_group() to wp_load_options_by_group().

Props peterwilsoncc, joemcgill, hellofromTonya, poran766, flixos90.
Fixes #58962.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (7 diffs)
• tests/phpunit/tests/option/primeOptions.php (deleted)
• tests/phpunit/tests/option/primeOptionsByGroup.php (deleted)
• tests/phpunit/tests/option/wpLoadOptions.php (added)
• tests/phpunit/tests/option/wpLoadOptionsByGroup.php (added)

trunk/src/wp-includes/option.php

@@ -249 +249 @@
 
 /**
- * Primes specific options into the cache with a single database query.
- *
- * Only options that do not already exist in cache will be primed.
+ * Loads specific options into the cache with a single database query.
+ *
+ * Only options that do not already exist in cache will be loaded.
  *
  * @since 6.4.0
@@ -257 +257 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param array $options An array of option names to be primed.
- */
-function prime_options( $options ) {
+ * @param array $options An array of option names to be loaded.
+ */
+function wp_load_options( $options ) {
     $alloptions     = wp_load_alloptions();
     $cached_options = wp_cache_get_multiple( $options, 'options' );
@@ -271 +271 @@
     }
 
-    // Bail early if there are no options to be primed.
+    // Bail early if there are no options to be loaded.
     if ( empty( $options_to_prime ) ) {
         return;
@@ -322 +322 @@
 
 /**
- * Primes all options registered with a specific option group.
+ * Loads all options registered with a specific option group.
  *
  * @since 6.4.0
@@ -328 +328 @@
  * @global array $new_allowed_options
  *
- * @param string $option_group The option group to prime options for.
- */
-function prime_options_by_group( $option_group ) {
+ * @param string $option_group The option group to load options for.
+ */
+function wp_load_options_by_group( $option_group ) {
     global $new_allowed_options;
 
     if ( isset( $new_allowed_options[ $option_group ] ) ) {
-        prime_options( $new_allowed_options[ $option_group ] );
+        wp_load_options( $new_allowed_options[ $option_group ] );
     }
 }
@@ -341 +341 @@
  * Retrieves multiple options.
  *
- * Options are primed as necessary first in order to use a single database query at most.
+ * Options are loaded as necessary first in order to use a single database query at most.
  *
  * @since 6.4.0
@@ -349 +349 @@
  */
 function get_options( $options ) {
-    prime_options( $options );
+    wp_load_options( $options );
 
     $result = array();