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.
Merges [56990] to the 6.4 branch.
Fixes #58962.

Built from https://develop.svn.wordpress.org/branches/6.4@57004


git-svn-id: http://core.svn.wordpress.org/branches/6.4@56515 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Felix Arntz 2023-10-24 14:37:16 +00:00
parent f49b05f8f2
commit 04e82f9f08
2 changed files with 12 additions and 12 deletions

View File

@ -248,17 +248,17 @@ function get_option( $option, $default_value = false ) {
} }
/** /**
* Primes specific options into the cache with a single database query. * Loads specific options into the cache with a single database query.
* *
* Only options that do not already exist in cache will be primed. * Only options that do not already exist in cache will be loaded.
* *
* @since 6.4.0 * @since 6.4.0
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param array $options An array of option names to be primed. * @param array $options An array of option names to be loaded.
*/ */
function prime_options( $options ) { function wp_load_options( $options ) {
$alloptions = wp_load_alloptions(); $alloptions = wp_load_alloptions();
$cached_options = wp_cache_get_multiple( $options, 'options' ); $cached_options = wp_cache_get_multiple( $options, 'options' );
@ -270,7 +270,7 @@ function prime_options( $options ) {
} }
} }
// 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 ) ) { if ( empty( $options_to_prime ) ) {
return; return;
} }
@ -321,26 +321,26 @@ function prime_options( $options ) {
} }
/** /**
* Primes all options registered with a specific option group. * Loads all options registered with a specific option group.
* *
* @since 6.4.0 * @since 6.4.0
* *
* @global array $new_allowed_options * @global array $new_allowed_options
* *
* @param string $option_group The option group to prime options for. * @param string $option_group The option group to load options for.
*/ */
function prime_options_by_group( $option_group ) { function wp_load_options_by_group( $option_group ) {
global $new_allowed_options; global $new_allowed_options;
if ( isset( $new_allowed_options[ $option_group ] ) ) { if ( isset( $new_allowed_options[ $option_group ] ) ) {
prime_options( $new_allowed_options[ $option_group ] ); wp_load_options( $new_allowed_options[ $option_group ] );
} }
} }
/** /**
* Retrieves multiple options. * 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 * @since 6.4.0
* *
@ -348,7 +348,7 @@ function prime_options_by_group( $option_group ) {
* @return array An array of key-value pairs for the requested options. * @return array An array of key-value pairs for the requested options.
*/ */
function get_options( $options ) { function get_options( $options ) {
prime_options( $options ); wp_load_options( $options );
$result = array(); $result = array();
foreach ( $options as $option ) { foreach ( $options as $option ) {

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.4-RC1-57002'; $wp_version = '6.4-RC1-57004';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.