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

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.

$optionstring

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

$valuemixed

Option value, can be anything. Expected to not be SQL-escaped.

Return value

bool

True if the option was added, false otherwise.

Performance profile

How much work a call to add_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 add_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–102

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

Plugin surface

3 hooks

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

Called by

2

2 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
• optionoption read or writeadd_option()called directly
• cacheobject cachewp_cache_get()called directly
• serializeserialisationmaybe_serialize()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 add_network_option() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

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

1. 1
   apply_filters( pre_add_site_option_{$option} )filterline 2184 (+30 into the body)

   Filters the value of a specific network option before it is added.

2. 2
   do_action( add_site_option_{$option} )actionline 2247 (+93 into the body)

   Fires after a specific network option has been successfully added.

3. 3
   do_action( add_site_option )actionline 2259 (+105 into the body)

   Fires after a network option has been successfully added.

Uses · 11

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

Used by · 2

• add_site_option()Adds a new option for the current network.
• update_network_option()Updates the value of a network option that was already added.

Source code

View on Trac ↗View on GitHub ↗

2154function add_network_option( $network_id, $option, $value ) {2155	global $wpdb;2156 2157	if ( $network_id && ! is_numeric( $network_id ) ) {2158		return false;2159	}2160 2161	$network_id = (int) $network_id;2162 2163	// Fallback to the current network if a network ID is not specified.2164	if ( ! $network_id ) {2165		$network_id = get_current_network_id();2166	}2167 2168	wp_protect_special_option( $option );2169 2170	/**2171	 * Filters the value of a specific network option before it is added.2172	 *2173	 * The dynamic portion of the hook name, `$option`, refers to the option name.2174	 *2175	 * @since 2.9.0 As `pre_add_site_option_{$key}`.2176	 * @since 3.0.02177	 * @since 4.4.0 The `$option` parameter was added.2178	 * @since 4.7.0 The `$network_id` parameter was added.2179	 *2180	 * @param mixed  $value      Value of network option.2181	 * @param string $option     Option name.2182	 * @param int    $network_id ID of the network.2183	 */2184	$value = apply_filters( "pre_add_site_option_{$option}", $value, $option, $network_id );2185 2186	$notoptions_key = "$network_id:notoptions";2187 2188	if ( ! is_multisite() ) {2189		$result = add_option( $option, $value, '', false );2190	} else {2191		$cache_key = "$network_id:$option";2192 2193		/*2194		 * Make sure the option doesn't already exist.2195		 * We can check the 'notoptions' cache before we ask for a DB query.2196		 */2197		$notoptions = wp_cache_get( $notoptions_key, 'site-options' );2198 2199		if ( ! is_array( $notoptions ) || ! isset( $notoptions[ $option ] ) ) {2200			if ( false !== get_network_option( $network_id, $option, false ) ) {2201				return false;2202			}2203		}2204 2205		$value = sanitize_option( $option, $value );2206 2207		$serialized_value = maybe_serialize( $value );2208		$result           = $wpdb->insert(2209			$wpdb->sitemeta,2210			array(2211				'site_id'    => $network_id,2212				'meta_key'   => $option,2213				'meta_value' => $serialized_value,2214			)2215		);2216 2217		if ( ! $result ) {2218			return false;2219		}2220 2221		wp_cache_set( $cache_key, $value, 'site-options' );2222 2223		// This option exists now.2224		$notoptions = wp_cache_get( $notoptions_key, 'site-options' ); // Yes, again... we need it to be fresh.2225 2226		if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) {2227			unset( $notoptions[ $option ] );2228			wp_cache_set( $notoptions_key, $notoptions, 'site-options' );2229		}2230	}2231 2232	if ( $result ) {2233

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 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.