get_network_option( int|null $network_id, string $option, mixed $default_value = false ): mixed

Parameters

$network_idint|null

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

$optionstring

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

$default_valuemixedoptional

Value to return if the option doesn't exist. Default false.Default: false

Return

mixed

Value set for the option.

Cost profile

Measured from the compiled opcodes, not from a stopwatch. Every number here is identical on any machine that runs the same PHP version, and every function in core is ranked by these figures.

Cost class

Heavy

Reaches the database via ->get_row().

Scaling

Constant

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

Instructions

8–106

Executed per call on PHP 8.4, depending on the branch taken. The body compiles to 142.

Plugin surface

4 hooks

Third-party callbacks on 'pre_site_option_{$option}', 'pre_site_option', 'default_site_option_{$option}' 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

• optionnetwork optionget_network_option()this function does it
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()called directly
• serializeserialisationmaybe_unserialize()called directly
• sqldatabase query->get_row()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 · 21 distinct outcomes

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

Across PHP versions

Oldest PHP that compiles this body: 7.4. An instruction is not a fixed amount of time, so a version with the same count is not necessarily the same speed; what the count rules out is a difference in the work itself.

Hooks fired · 6

6 hooks fire while get_network_option() runs, in this order:

1. 1
   apply_filters( pre_site_option_{$option} )filterline 2038 (+37 into the body)

   Filters the value of an existing network option before it is retrieved.

2. 2
   apply_filters( pre_site_option )filterline 2057 (+56 into the body)

   Filters the value of any existing network option before it is retrieved.

3. 3
   apply_filters( default_site_option_{$option} )filterline 2083 (+82 into the body)

   Filters the value of a specific default network option.

4. 4
   apply_filters( default_site_option_{$option} )filterline 2088 (+87 into the body)

   Filters the value of a specific default network option.

5. 5
   apply_filters( default_site_option_{$option} )filterline 2111 (+110 into the body)

   Filters the value of a specific default network option.

6. 6
   apply_filters( site_option_{$option} )filterline 2135 (+134 into the body)

   Filters the value of an existing network option.

Uses · 7

• get_current_network_id()Retrieves the current network ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• is_multisite()Determines whether Multisite is enabled.
• get_option()Retrieves an option value based on an option name.
• maybe_unserialize()Unserializes data only if it was serialized.
• wp_cache_set()Saves the data to the cache.

Used by · 12

• WP_Application_Passwords::create_new_application_password()Creates a new application password.
• WP_Application_Passwords::is_in_use()Checks if application passwords are being used by the site.
• WP_Network::_set_site_name()Sets the site name assigned to the network if one has not been populated.
• WP_Network::get_main_site_id()Returns the main site ID for the network.
• add_network_option()Adds a new network option.
• get_blog_count()Gets the number of active sites on the installation.
• get_site_option()Retrieve an option value for the current network based on name of option.
• get_user_count()Returns the number of active users in your installation.
• is_site_meta_supported()Determines whether site meta is enabled.
• update_network_option()Updates the value of a network option that was already added.
• wp_initialize_site()Runs the initialization routine for a given site.
• wp_insert_site()Inserts a new site into the database.

Source

View on Trac ↗View on GitHub ↗

2001function get_network_option( $network_id, $option, $default_value = false ) {2002	global $wpdb;2003 2004	if ( $network_id && ! is_numeric( $network_id ) ) {2005		return false;2006	}2007 2008	$network_id = (int) $network_id;2009 2010	// Fallback to the current network if a network ID is not specified.2011	if ( ! $network_id ) {2012		$network_id = get_current_network_id();2013	}2014 2015	/**2016	 * Filters the value of an existing network option before it is retrieved.2017	 *2018	 * The dynamic portion of the hook name, `$option`, refers to the option name.2019	 *2020	 * Returning a value other than false from the filter will short-circuit retrieval2021	 * and return that value instead.2022	 *2023	 * @since 2.9.0 As `pre_site_option_{$key}`.2024	 * @since 3.0.02025	 * @since 4.4.0 The `$option` parameter was added.2026	 * @since 4.7.0 The `$network_id` parameter was added.2027	 * @since 4.9.0 The `$default_value` parameter was added.2028	 *2029	 * @param mixed  $pre_site_option The value to return instead of the option value. This differs from2030	 *                                `$default_value`, which is used as the fallback value in the event2031	 *                                the option doesn't exist elsewhere in get_network_option().2032	 *                                Default false (to skip past the short-circuit).2033	 * @param string $option          Option name.2034	 * @param int    $network_id      ID of the network.2035	 * @param mixed  $default_value   The fallback value to return if the option does not exist.2036	 *                                Default false.2037	 */2038	$pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default_value );2039 2040	/**2041	 * Filters the value of any existing network option before it is retrieved.2042	 *2043	 * Returning a value other than false from the filter will short-circuit retrieval2044	 * and return that value instead.2045	 *2046	 * @since 6.9.02047	 *2048	 * @param mixed  $pre_option    The value to return instead of the network option value. This differs2049	 *                              from `$default_value`, which is used as the fallback value in the event2050	 *                              the option doesn't exist elsewhere in get_network_option().2051	 *                              Default false (to skip past the short-circuit).2052	 * @param string $option        Name of the option.2053	 * @param int    $network_id    ID of the network.2054	 * @param mixed  $default_value The fallback value to return if the option does not exist.2055	 *                              Default false.2056	 */2057	$pre = apply_filters( 'pre_site_option', $pre, $option, $network_id, $default_value );2058 2059	if ( false !== $pre ) {2060		return $pre;2061	}2062 2063	// Prevent non-existent options from triggering multiple queries.2064	$notoptions_key = "$network_id:notoptions";2065	$notoptions     = wp_cache_get( $notoptions_key, 'site-options' );2066 2067	if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) {2068 2069		/**2070		 * Filters the value of a specific default network option.2071		 *2072		 * The dynamic portion of the hook name, `$option`, refers to the option name.2073		 *2074		 * @since 3.4.02075		 * @since 4.4.0 The `$option` parameter was added.2076		 * @since 4.7.0 The `$network_id` parameter was added.2077		 *2078		 * @param mixed  $default_value The value to return if the site option does not exist2079		 *                              in the database.2080		 * @param string $option        Option name.

History

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.