wp_load_alloptions( bool $force_cache = false ): array
- Since
- 2.2.0, 5.3.1
- Source
wp-includes/option.php:592
Loads and caches all autoloaded options, if available or all options.
Parameters
$force_cachebooloptional- Whether to force an update of the local cache from the persistent cache. Default false.Default:
false
Return
array- List of all options.
Hooks fired · 3
3 hooks fire while wp_load_alloptions() runs, in this order:
- apply_filters( pre_wp_load_alloptions )filterline 606 (+14 into the body)
Filters the array of alloptions before it is populated.
- apply_filters( pre_cache_alloptions )filterline 639 (+47 into the body)
Filters all options before caching them.
- apply_filters( alloptions )filterline 652 (+60 into the body)
Filters all options after retrieving them.
Uses · 7
- apply_filters()Calls the callback functions that have been added to a filter hook.
- wp_installing()Checks or sets whether WordPress is in "installation" mode.
- is_multisite()Determines whether Multisite is enabled.
- wp_cache_get()Retrieves the cache contents from the cache by key and group.
- esc_sql()Escapes data for use in a MySQL query.
- wp_autoload_values_to_autoload()Returns the values that trigger autoloading from the options table.
- wp_cache_add()Adds data to the cache, if the cache key doesn't already exist.
Used by · 12
- WP_Site_Health::get_autoloaded_options_size()Calculates total amount of autoloaded data.
- WP_Site_Health::get_test_autoloaded_options()Tests the number of autoloaded options.
- WP_Site_Health::should_suggest_persistent_object_cache()Determines whether to suggest using a persistent object cache.
- add_option()Adds a new option.
- delete_option()Removes an option by name. Prevents removal of protected WordPress options.
- get_alloptions()Retrieve all autoload options, or all options if no autoloaded ones exist.
- get_option()Retrieves an option value based on an option name.
- get_transient()Retrieves the value of a transient.
- is_blog_installed()Determines whether WordPress is already installed.
- update_option()Updates the value of an option that was already added.
- wp_prime_option_caches()Primes specific options into the cache with a single database query.
- wp_set_option_autoload_values()Sets the autoload values for multiple options in the database.
Source
function wp_load_alloptions( $force_cache = false ) { global $wpdb; /** * Filters the array of alloptions before it is populated. * * Returning an array from the filter will effectively short circuit * wp_load_alloptions(), returning that value instead. * * @since 6.2.0 * * @param array|null $alloptions An array of alloptions. Default null. * @param bool $force_cache Whether to force an update of the local cache from the persistent cache. Default false. */ $alloptions = apply_filters( 'pre_wp_load_alloptions', null, $force_cache ); if ( is_array( $alloptions ) ) { return $alloptions; } if ( ! wp_installing() || ! is_multisite() ) { $alloptions = wp_cache_get( 'alloptions', 'options', $force_cache ); } else { $alloptions = false; } if ( ! $alloptions ) { $suppress = $wpdb->suppress_errors(); $alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload IN ( '" . implode( "', '", esc_sql( wp_autoload_values_to_autoload() ) ) . "' )" ); if ( ! $alloptions_db ) { $alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options" ); } $wpdb->suppress_errors( $suppress ); $alloptions = array(); foreach ( (array) $alloptions_db as $o ) { $alloptions[ $o->option_name ] = $o->option_value; } if ( ! wp_installing() || ! is_multisite() ) { /** * Filters all options before caching them. * * @since 4.9.0 * * @param array $alloptions Array with all options. */ $alloptions = apply_filters( 'pre_cache_alloptions', $alloptions ); wp_cache_add( 'alloptions', $alloptions, 'options' ); } } /** * Filters all options after retrieving them. * * @since 4.9.0 * * @param array $alloptions Array with all options. */ return apply_filters( 'alloptions', $alloptions );}History
Introduced in 2.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
5.3.1
The
$force_cache parameter was added.from the docblock2.2.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/option.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.