wp_prime_network_option_caches( int|null $network_id, string[] $options )

Description

Compatibility

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

Parameters

$network_idint|null

ID of the network. Can be null to default to the current network ID.

$optionsstring[]

An array of option names to be loaded.

Performance profile

How much work a call to wp_prime_network_option_caches() 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

7–102

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

What it touches

• cacheobject cachewp_cache_get_multiple()called directly
• serializeserialisationmaybe_unserialize()called directly
• sqldatabase query->get_results()called directly

Further down the call graph this can also reach hook. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 11 distinct outcomes

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

Uses · 9

• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• is_multisite()Determines whether Multisite is enabled.
• wp_prime_option_caches()Primes specific options into the cache with a single database query.
• get_current_network_id()Retrieves the current network ID.
• wp_cache_get_multiple()Retrieves multiple values from the cache in one call.
• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• maybe_unserialize()Unserializes data only if it was serialized.
• wp_cache_set_multiple()Sets multiple values to the cache in one call.
• wp_cache_set()Saves the data to the cache.

Used by · 2

• wp_load_core_site_options()Loads and primes caches of certain often requested network options if is_multisite().
• wp_prime_site_option_caches()Primes specific network options for the current network into the cache with a single database query.

Source code

View on Trac ↗View on GitHub ↗

694function wp_prime_network_option_caches( $network_id, array $options ) {695	global $wpdb;696 697	if ( wp_installing() ) {698		return;699	}700 701	if ( ! is_multisite() ) {702		wp_prime_option_caches( $options );703		return;704	}705 706	if ( $network_id && ! is_numeric( $network_id ) ) {707		return;708	}709 710	$network_id = (int) $network_id;711 712	// Fallback to the current network if a network ID is not specified.713	if ( ! $network_id ) {714		$network_id = get_current_network_id();715	}716 717	$cache_keys = array();718	foreach ( $options as $option ) {719		$cache_keys[ $option ] = "{$network_id}:{$option}";720	}721 722	$cache_group    = 'site-options';723	$cached_options = wp_cache_get_multiple( array_values( $cache_keys ), $cache_group );724 725	$notoptions_key = "$network_id:notoptions";726	$notoptions     = wp_cache_get( $notoptions_key, $cache_group );727 728	if ( ! is_array( $notoptions ) ) {729		$notoptions = array();730	}731 732	// Filter options that are not in the cache.733	$options_to_prime = array();734	foreach ( $cache_keys as $option => $cache_key ) {735		if (736			( ! isset( $cached_options[ $cache_key ] ) || false === $cached_options[ $cache_key ] )737			&& ! isset( $notoptions[ $option ] )738		) {739			$options_to_prime[] = $option;740		}741	}742 743	// Bail early if there are no options to be loaded.744	if ( empty( $options_to_prime ) ) {745		return;746	}747 748	$query_args   = $options_to_prime;749	$query_args[] = $network_id;750	$results      = $wpdb->get_results(751		$wpdb->prepare(752			sprintf(753				"SELECT meta_key, meta_value FROM $wpdb->sitemeta WHERE meta_key IN (%s) AND site_id = %s",754				implode( ',', array_fill( 0, count( $options_to_prime ), '%s' ) ),755				'%d'756			),757			$query_args758		)759	);760 761	$data          = array();762	$options_found = array();763	foreach ( $results as $result ) {764		$key                = $result->meta_key;765		$cache_key          = $cache_keys[ $key ];766		$data[ $cache_key ] = maybe_unserialize( $result->meta_value );767		$options_found[]    = $key;768	}769	wp_cache_set_multiple( $data, $cache_group );770	// If all options were found, no need to update `notoptions` cache.771	if ( count( $options_found ) === count( $options_to_prime ) ) {772		return;773	}

Changelog

Introduced in 6.6.0. One change between 6.7.7 and 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.