update_network_option( int|null $network_id, string $option, mixed $value ): bool

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.

$optionstring

Name of the option. Expected to not be SQL-escaped.

$valuemixed

Option value. Expected to not be SQL-escaped.

Return value

bool

True if the value was updated, false otherwise.

Performance profile

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

Moderate

Reads stored settings via update_network_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–107

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

Plugin surface

3 hooks

Third-party callbacks on 'pre_update_site_option_{$option}', 'update_site_option_{$option}', 'update_site_option' run inside this call, and their cost is not bounded by anything here.

Called by

7

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

What it touches

• optionnetwork optionupdate_network_option()this function does it
• hookthird-party callbacksapply_filters()called directly
• serializeserialisationmaybe_serialize()called directly
• cacheobject cachewp_cache_get()called directly

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 27 distinct outcomes

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

Hooks and filters fired · 3

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

1. 1
   apply_filters( pre_update_site_option_{$option} )filterline 2418 (+33 into the body)

   Filters a specific network option before its value is updated.

2. 2
   do_action( update_site_option_{$option} )actionline 2482 (+97 into the body)

   Fires after the value of a specific network option has been successfully updated.

3. 3
   do_action( update_site_option )actionline 2495 (+110 into the body)

   Fires after the value of a network option has been successfully updated.

Uses · 12

• get_current_network_id()Retrieves the current network ID.
• wp_protect_special_option()Protects WordPress special option from being modified.
• get_network_option()Retrieves a network's option value based on the option name.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• maybe_serialize()Serializes data, if needed.
• add_network_option()Adds a new network option.
• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• wp_cache_set()Saves the data to the cache.
• is_multisite()Determines whether Multisite is enabled.
• update_option()Updates the value of an option that was already added.
• sanitize_option()Sanitizes various option values based on the nature of the option.
• do_action()Calls the callback functions that have been added to an action hook.

Used by · 7

• WP_Application_Passwords::create_new_application_password()Creates a new application password.
• WP_Network::get_main_site_id()Returns the main site ID for the network.
• is_site_meta_supported()Determines whether site meta is enabled.
• update_site_option()Updates the value of an option that was already added for the current network.
• upgrade_560()Executes changes made in WordPress 5.6.0.
• wp_update_network_site_counts()Updates the network-wide site count.
• wp_update_user_counts()Updates the total count of users on the site.

Source code

View on Trac ↗View on GitHub ↗

2385function update_network_option( $network_id, $option, $value ) {2386	global $wpdb;2387 2388	if ( $network_id && ! is_numeric( $network_id ) ) {2389		return false;2390	}2391 2392	$network_id = (int) $network_id;2393 2394	// Fallback to the current network if a network ID is not specified.2395	if ( ! $network_id ) {2396		$network_id = get_current_network_id();2397	}2398 2399	wp_protect_special_option( $option );2400 2401	$old_value = get_network_option( $network_id, $option );2402 2403	/**2404	 * Filters a specific network option before its value is updated.2405	 *2406	 * The dynamic portion of the hook name, `$option`, refers to the option name.2407	 *2408	 * @since 2.9.0 As 'pre_update_site_option_' . $key2409	 * @since 3.0.02410	 * @since 4.4.0 The `$option` parameter was added.2411	 * @since 4.7.0 The `$network_id` parameter was added.2412	 *2413	 * @param mixed  $value      New value of the network option.2414	 * @param mixed  $old_value  Old value of the network option.2415	 * @param string $option     Option name.2416	 * @param int    $network_id ID of the network.2417	 */2418	$value = apply_filters( "pre_update_site_option_{$option}", $value, $old_value, $option, $network_id );2419 2420	/*2421	 * If the new and old values are the same, no need to update.2422	 *2423	 * Unserialized values will be adequate in most cases. If the unserialized2424	 * data differs, the (maybe) serialized data is checked to avoid2425	 * unnecessary database calls for otherwise identical object instances.2426	 *2427	 * See https://core.trac.wordpress.org/ticket/449562428	 */2429	if ( $value === $old_value || maybe_serialize( $value ) === maybe_serialize( $old_value ) ) {2430		return false;2431	}2432 2433	if ( false === $old_value ) {2434		return add_network_option( $network_id, $option, $value );2435	}2436 2437	$notoptions_key = "$network_id:notoptions";2438	$notoptions     = wp_cache_get( $notoptions_key, 'site-options' );2439 2440	if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) {2441		unset( $notoptions[ $option ] );2442		wp_cache_set( $notoptions_key, $notoptions, 'site-options' );2443	}2444 2445	if ( ! is_multisite() ) {2446		$result = update_option( $option, $value, false );2447	} else {2448		$value = sanitize_option( $option, $value );2449 2450		$serialized_value = maybe_serialize( $value );2451		$result           = $wpdb->update(2452			$wpdb->sitemeta,2453			array( 'meta_value' => $serialized_value ),2454			array(2455				'site_id'  => $network_id,2456				'meta_key' => $option,2457			)2458		);2459 2460		if ( $result ) {2461			$cache_key = "$network_id:$option";2462			wp_cache_set( $cache_key, $value, 'site-options' );2463		}2464	}

Changelog

Introduced in 4.4.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 6.9.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.