wp_load_alloptions( bool $force_cache = false ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$force_cachebooloptional

Whether to force an update of the local cache from the persistent cache. Default false.Default: false

Return value

array

List of all options.

Performance profile

How much work a call to wp_load_alloptions() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->get_results().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

11–79

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 86.

Plugin surface

3 hooks

Third-party callbacks on 'pre_wp_load_alloptions', 'pre_cache_alloptions', 'alloptions' run inside this call, and their cost is not bounded by anything here.

Called by

12

12 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()called directly
• sqldatabase query->get_results()called directly

What one call costs · 22 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_load_alloptions() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while wp_load_alloptions() runs, in this order:

1. 1
   apply_filters( pre_wp_load_alloptions )filterline 614 (+14 into the body)

   Filters the array of alloptions before it is populated.

2. 2
   apply_filters( pre_cache_alloptions )filterline 647 (+47 into the body)

   Filters all options before caching them.

3. 3
   apply_filters( alloptions )filterline 660 (+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 code

View on Trac ↗View on GitHub ↗

600function wp_load_alloptions( $force_cache = false ) {601	global $wpdb;602 603	/**604	 * Filters the array of alloptions before it is populated.605	 *606	 * Returning an array from the filter will effectively short circuit607	 * wp_load_alloptions(), returning that value instead.608	 *609	 * @since 6.2.0610	 *611	 * @param array|null $alloptions  An array of alloptions. Default null.612	 * @param bool       $force_cache Whether to force an update of the local cache from the persistent cache. Default false.613	 */614	$alloptions = apply_filters( 'pre_wp_load_alloptions', null, $force_cache );615	if ( is_array( $alloptions ) ) {616		return $alloptions;617	}618 619	if ( ! wp_installing() || ! is_multisite() ) {620		$alloptions = wp_cache_get( 'alloptions', 'options', $force_cache );621	} else {622		$alloptions = false;623	}624 625	if ( ! $alloptions ) {626		$suppress      = $wpdb->suppress_errors();627		$alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload IN ( '" . implode( "', '", esc_sql( wp_autoload_values_to_autoload() ) ) . "' )" );628 629		if ( ! $alloptions_db ) {630			$alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options" );631		}632		$wpdb->suppress_errors( $suppress );633 634		$alloptions = array();635		foreach ( (array) $alloptions_db as $o ) {636			$alloptions[ $o->option_name ] = $o->option_value;637		}638 639		if ( ! wp_installing() || ! is_multisite() ) {640			/**641			 * Filters all options before caching them.642			 *643			 * @since 4.9.0644			 *645			 * @param array $alloptions Array with all options.646			 */647			$alloptions = apply_filters( 'pre_cache_alloptions', $alloptions );648 649			wp_cache_add( 'alloptions', $alloptions, 'options' );650		}651	}652 653	/**654	 * Filters all options after retrieving them.655	 *656	 * @since 4.9.0657	 *658	 * @param array $alloptions Array with all options.659	 */660	return apply_filters( 'alloptions', $alloptions );661}

Changelog

Introduced in 2.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.