get_network_option

Retrieve a network's option value based on the option name.

Description

get_network_option( (int) $network_id, (string) $option, (bool) $default = false ); 

Parameters (3)

0. $network_id (int)
ID of the network. Can be null to default to the current network ID.
1. $option (string)
Name of option to retrieve. Expected to not be SQL-escaped.
2. $default — Optional. (bool) => false
Value to return if the option doesn't exist. Default false.

Usage

  1. if ( !function_exists( 'get_network_option' ) ) { 
  2.     require_once ABSPATH . WPINC . '/option.php'; 
  3. } 
  4.   
  5. // ID of the network. Can be null to default to the current network ID. 
  6. $network_id = -1; 
  7.   
  8. // Name of option to retrieve. Expected to not be SQL-escaped. 
  9. $option = ''; 
  10.   
  11. // Optional. Value to return if the option doesn't exist. Default false. 
  12. $default = false; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = get_network_option($network_id, $option, $default); 
  16.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/option.php  
  1. function get_network_option( $network_id, $option, $default = false ) { 
  2.     global $wpdb; 
  3.  
  4.     if ( $network_id && ! is_numeric( $network_id ) ) { 
  5.         return false; 
  6.     } 
  7.  
  8.     $network_id = (int) $network_id; 
  9.  
  10.     // Fallback to the current network if a network ID is not specified. 
  11.     if ( ! $network_id ) { 
  12.         $network_id = get_current_network_id(); 
  13.     } 
  14.  
  15.     /** 
  16.      * Filters an existing network option before it is retrieved. 
  17.      * 
  18.      * The dynamic portion of the hook name, `$option`, refers to the option name. 
  19.      * 
  20.      * Passing a truthy value to the filter will effectively short-circuit retrieval,  
  21.      * returning the passed value instead. 
  22.      * 
  23.      * @since 2.9.0 As 'pre_site_option_' . $key 
  24.      * @since 3.0.0 
  25.      * @since 4.4.0 The `$option` parameter was added. 
  26.      * @since 4.7.0 The `$network_id` parameter was added. 
  27.      * 
  28.      * @param mixed  $pre_option The default value to return if the option does not exist. 
  29.      * @param string $option     Option name. 
  30.      * @param int    $network_id ID of the network. 
  31.      */ 
  32.     $pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id ); 
  33.  
  34.     if ( false !== $pre ) { 
  35.         return $pre; 
  36.     } 
  37.  
  38.     // prevent non-existent options from triggering multiple queries 
  39.     $notoptions_key = "$network_id:notoptions"; 
  40.     $notoptions = wp_cache_get( $notoptions_key, 'site-options' ); 
  41.  
  42.     if ( isset( $notoptions[ $option ] ) ) { 
  43.  
  44.         /** 
  45.          * Filters a specific default network option. 
  46.          * 
  47.          * The dynamic portion of the hook name, `$option`, refers to the option name. 
  48.          * 
  49.          * @since 3.4.0 
  50.          * @since 4.4.0 The `$option` parameter was added. 
  51.          * @since 4.7.0 The `$network_id` parameter was added. 
  52.          * 
  53.          * @param mixed  $default    The value to return if the site option does not exist 
  54.          *                           in the database. 
  55.          * @param string $option     Option name. 
  56.          * @param int    $network_id ID of the network. 
  57.          */ 
  58.         return apply_filters( "default_site_option_{$option}", $default, $option, $network_id ); 
  59.     } 
  60.  
  61.     if ( ! is_multisite() ) { 
  62.         /** This filter is documented in wp-includes/option.php */ 
  63.         $default = apply_filters( 'default_site_option_' . $option, $default, $option, $network_id ); 
  64.         $value = get_option( $option, $default ); 
  65.     } else { 
  66.         $cache_key = "$network_id:$option"; 
  67.         $value = wp_cache_get( $cache_key, 'site-options' ); 
  68.  
  69.         if ( ! isset( $value ) || false === $value ) { 
  70.             $row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_value FROM $wpdb->sitemeta WHERE meta_key = %s AND site_id = %d", $option, $network_id ) ); 
  71.  
  72.             // Has to be get_row instead of get_var because of funkiness with 0, false, null values 
  73.             if ( is_object( $row ) ) { 
  74.                 $value = $row->meta_value; 
  75.                 $value = maybe_unserialize( $value ); 
  76.                 wp_cache_set( $cache_key, $value, 'site-options' ); 
  77.             } else { 
  78.                 if ( ! is_array( $notoptions ) ) { 
  79.                     $notoptions = array(); 
  80.                 } 
  81.                 $notoptions[ $option ] = true; 
  82.                 wp_cache_set( $notoptions_key, $notoptions, 'site-options' ); 
  83.  
  84.                 /** This filter is documented in wp-includes/option.php */ 
  85.                 $value = apply_filters( 'default_site_option_' . $option, $default, $option, $network_id ); 
  86.             } 
  87.         } 
  88.     } 
  89.  
  90.     /** 
  91.      * Filters the value of an existing network option. 
  92.      * 
  93.      * The dynamic portion of the hook name, `$option`, refers to the option name. 
  94.      * 
  95.      * @since 2.9.0 As 'site_option_' . $key 
  96.      * @since 3.0.0 
  97.      * @since 4.4.0 The `$option` parameter was added. 
  98.      * @since 4.7.0 The `$network_id` parameter was added. 
  99.      * 
  100.      * @param mixed  $value      Value of network option. 
  101.      * @param string $option     Option name. 
  102.      * @param int    $network_id ID of the network. 
  103.      */ 
  104.     return apply_filters( "site_option_{$option}", $value, $option, $network_id ); 
  105. }