X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/dc1231b7312fbdca99e9e887cc2bb35a28f85cdc..refs/tags/wordpress-4.4:/wp-includes/option.php diff --git a/wp-includes/option.php b/wp-includes/option.php index 1b5dde23..6d9fe645 100644 --- a/wp-includes/option.php +++ b/wp-includes/option.php @@ -18,7 +18,7 @@ * * @since 1.5.0 * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * * @param string $option Name of option to retrieve. Expected to not be SQL-escaped. * @param mixed $default Optional. Default value to return if the option does not exist. @@ -40,18 +40,20 @@ function get_option( $option, $default = false ) { * the option value, returning the passed value instead. * * @since 1.5.0 + * @since 4.4.0 The `$option` parameter was added. * * @param bool|mixed $pre_option Value to return instead of the option value. * Default false to skip it. + * @param string $option Option name. */ - $pre = apply_filters( 'pre_option_' . $option, false ); + $pre = apply_filters( 'pre_option_' . $option, false, $option ); if ( false !== $pre ) return $pre; if ( defined( 'WP_SETUP_CONFIG' ) ) return false; - if ( ! defined( 'WP_INSTALLING' ) ) { + if ( ! wp_installing() ) { // prevent non-existent options from triggering multiple queries $notoptions = wp_cache_get( 'notoptions', 'options' ); if ( isset( $notoptions[ $option ] ) ) { @@ -61,11 +63,13 @@ function get_option( $option, $default = false ) { * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 3.4.0 + * @since 4.4.0 The `$option` parameter was added. * - * @param mixed $default The default value to return if the option does not exist - * in the database. + * @param mixed $default The default value to return if the option does not exist + * in the database. + * @param string $option Option name. */ - return apply_filters( 'default_option_' . $option, $default ); + return apply_filters( 'default_option_' . $option, $default, $option ); } $alloptions = wp_load_alloptions(); @@ -90,7 +94,7 @@ function get_option( $option, $default = false ) { wp_cache_set( 'notoptions', $notoptions, 'options' ); /** This filter is documented in wp-includes/option.php */ - return apply_filters( 'default_option_' . $option, $default ); + return apply_filters( 'default_option_' . $option, $default, $option ); } } } @@ -102,7 +106,7 @@ function get_option( $option, $default = false ) { $value = $row->option_value; } else { /** This filter is documented in wp-includes/option.php */ - return apply_filters( 'default_option_' . $option, $default ); + return apply_filters( 'default_option_' . $option, $default, $option ); } } @@ -120,11 +124,13 @@ function get_option( $option, $default = false ) { * * @since 1.5.0 As 'option_' . $setting * @since 3.0.0 + * @since 4.4.0 The `$option` parameter was added. * - * @param mixed $value Value of the option. If stored serialized, it will be - * unserialized prior to being returned. + * @param mixed $value Value of the option. If stored serialized, it will be + * unserialized prior to being returned. + * @param string $option Option name. */ - return apply_filters( 'option_' . $option, maybe_unserialize( $value ) ); + return apply_filters( 'option_' . $option, maybe_unserialize( $value ), $option ); } /** @@ -158,14 +164,14 @@ function form_option( $option ) { * * @since 2.2.0 * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * * @return array List of all options. */ function wp_load_alloptions() { global $wpdb; - if ( !defined( 'WP_INSTALLING' ) || !is_multisite() ) + if ( ! wp_installing() || ! is_multisite() ) $alloptions = wp_cache_get( 'alloptions', 'options' ); else $alloptions = false; @@ -179,7 +185,7 @@ function wp_load_alloptions() { foreach ( (array) $alloptions_db as $o ) { $alloptions[$o->option_name] = $o->option_value; } - if ( !defined( 'WP_INSTALLING' ) || !is_multisite() ) + if ( ! wp_installing() || ! is_multisite() ) wp_cache_add( 'alloptions', $alloptions, 'options' ); } @@ -191,14 +197,14 @@ function wp_load_alloptions() { * * @since 3.0.0 * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $site_id Optional site ID for which to query the options. Defaults to the current site. */ function wp_load_core_site_options( $site_id = null ) { global $wpdb; - if ( !is_multisite() || wp_using_ext_object_cache() || defined( 'WP_INSTALLING' ) ) + if ( ! is_multisite() || wp_using_ext_object_cache() || wp_installing() ) return; if ( empty($site_id) ) @@ -231,7 +237,7 @@ function wp_load_core_site_options( $site_id = null ) { * @since 1.0.0 * @since 4.2.0 The `$autoload` parameter was added. * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * * @param string $option Option name. Expected to not be SQL-escaped. * @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped. @@ -262,11 +268,13 @@ function update_option( $option, $value, $autoload = null ) { * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 2.6.0 + * @since 4.4.0 The `$option` parameter was added. * - * @param mixed $value The new, unserialized option value. - * @param mixed $old_value The old option value. + * @param mixed $value The new, unserialized option value. + * @param mixed $old_value The old option value. + * @param string $option Option name. */ - $value = apply_filters( 'pre_update_option_' . $option, $value, $old_value ); + $value = apply_filters( 'pre_update_option_' . $option, $value, $old_value, $option ); /** * Filter an option before its value is (maybe) serialized and updated. @@ -324,7 +332,7 @@ function update_option( $option, $value, $autoload = null ) { wp_cache_set( 'notoptions', $notoptions, 'options' ); } - if ( ! defined( 'WP_INSTALLING' ) ) { + if ( ! wp_installing() ) { $alloptions = wp_load_alloptions(); if ( isset( $alloptions[$option] ) ) { $alloptions[ $option ] = $serialized_value; @@ -340,11 +348,13 @@ function update_option( $option, $value, $autoload = null ) { * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 2.0.1 + * @since 4.4.0 The `$option` parameter was added. * - * @param mixed $old_value The old option value. - * @param mixed $value The new option value. + * @param mixed $old_value The old option value. + * @param mixed $value The new option value. + * @param string $option Option name. */ - do_action( "update_option_{$option}", $old_value, $value ); + do_action( "update_option_{$option}", $old_value, $value, $option ); /** * Fires after the value of an option has been successfully updated. @@ -373,7 +383,7 @@ function update_option( $option, $value, $autoload = null ) { * * @since 1.0.0 * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * * @param string $option Name of option to add. Expected to not be SQL-escaped. * @param mixed $value Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped. @@ -423,7 +433,7 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) if ( ! $result ) return false; - if ( ! defined( 'WP_INSTALLING' ) ) { + if ( ! wp_installing() ) { if ( 'yes' == $autoload ) { $alloptions = wp_load_alloptions(); $alloptions[ $option ] = $serialized_value; @@ -470,7 +480,7 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) * * @since 1.2.0 * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * * @param string $option Name of option to remove. Expected to not be SQL-escaped. * @return bool True, if option is successfully deleted. False on failure. @@ -499,7 +509,7 @@ function delete_option( $option ) { do_action( 'delete_option', $option ); $result = $wpdb->delete( $wpdb->options, array( 'option_name' => $option ) ); - if ( ! defined( 'WP_INSTALLING' ) ) { + if ( ! wp_installing() ) { if ( 'yes' == $row->autoload ) { $alloptions = wp_load_alloptions(); if ( is_array( $alloptions ) && isset( $alloptions[$option] ) ) { @@ -595,7 +605,7 @@ function delete_transient( $transient ) { */ function get_transient( $transient ) { - /** + /** * Filter the value of an existing transient. * * The dynamic portion of the hook name, `$transient`, refers to the transient name. @@ -604,12 +614,14 @@ function get_transient( $transient ) { * of the transient, returning the passed value instead. * * @since 2.8.0 + * @since 4.4.0 The `$transient` parameter was added * - * @param mixed $pre_transient The default value to return if the transient does not exist. - * Any value other than false will short-circuit the retrieval - * of the transient, and return the returned value. + * @param mixed $pre_transient The default value to return if the transient does not exist. + * Any value other than false will short-circuit the retrieval + * of the transient, and return the returned value. + * @param string $transient Transient name. */ - $pre = apply_filters( 'pre_transient_' . $transient, false ); + $pre = apply_filters( 'pre_transient_' . $transient, false, $transient ); if ( false !== $pre ) return $pre; @@ -617,7 +629,7 @@ function get_transient( $transient ) { $value = wp_cache_get( $transient, 'transient' ); } else { $transient_option = '_transient_' . $transient; - if ( ! defined( 'WP_INSTALLING' ) ) { + if ( ! wp_installing() ) { // If option is not in alloptions, it is not autoloaded and thus has a timeout $alloptions = wp_load_alloptions(); if ( !isset( $alloptions[$transient_option] ) ) { @@ -641,10 +653,12 @@ function get_transient( $transient ) { * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 2.8.0 + * @since 4.4.0 The `$transient` parameter was added * - * @param mixed $value Value of transient. + * @param mixed $value Value of transient. + * @param string $transient Transient name. */ - return apply_filters( 'transient_' . $transient, $value ); + return apply_filters( 'transient_' . $transient, $value, $transient ); } /** @@ -656,10 +670,10 @@ function get_transient( $transient ) { * @since 2.8.0 * * @param string $transient Transient name. Expected to not be SQL-escaped. Must be - * 45 characters or fewer in length. + * 172 characters or fewer in length. * @param mixed $value Transient value. Must be serializable if non-scalar. * Expected to not be SQL-escaped. - * @param int $expiration Optional. Time until expiration in seconds. Default 0. + * @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration). * @return bool False if value was not set and true if value was set. */ function set_transient( $transient, $value, $expiration = 0 ) { @@ -672,41 +686,56 @@ function set_transient( $transient, $value, $expiration = 0 ) { * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 3.0.0 - * @since 4.2.0 Added `$expiration` parameter. + * @since 4.2.0 The `$expiration` parameter was added. + * @since 4.4.0 The `$transient` parameter was added. + * + * @param mixed $value New value of transient. + * @param int $expiration Time until expiration in seconds. + * @param string $transient Transient name. + */ + $value = apply_filters( 'pre_set_transient_' . $transient, $value, $expiration, $transient ); + + /** + * Filter the expiration for a transient before its value is set. + * + * The dynamic portion of the hook name, `$transient`, refers to the transient name. * - * @param mixed $value New value of transient. - * @param int $expiration Time until expiration in seconds. + * @since 4.4.0 + * + * @param int $expiration Time until expiration in seconds. Use 0 for no expiration. + * @param mixed $value New value of transient. + * @param string $transient Transient name. */ - $value = apply_filters( 'pre_set_transient_' . $transient, $value, $expiration ); + $expiration = apply_filters( 'expiration_of_transient_' . $transient, $expiration, $value, $transient ); if ( wp_using_ext_object_cache() ) { $result = wp_cache_set( $transient, $value, 'transient', $expiration ); } else { $transient_timeout = '_transient_timeout_' . $transient; - $transient = '_transient_' . $transient; - if ( false === get_option( $transient ) ) { + $transient_option = '_transient_' . $transient; + if ( false === get_option( $transient_option ) ) { $autoload = 'yes'; if ( $expiration ) { $autoload = 'no'; add_option( $transient_timeout, time() + $expiration, '', 'no' ); } - $result = add_option( $transient, $value, '', $autoload ); + $result = add_option( $transient_option, $value, '', $autoload ); } else { // If expiration is requested, but the transient has no timeout option, // delete, then re-create transient rather than update. $update = true; if ( $expiration ) { if ( false === get_option( $transient_timeout ) ) { - delete_option( $transient ); + delete_option( $transient_option ); add_option( $transient_timeout, time() + $expiration, '', 'no' ); - $result = add_option( $transient, $value, '', 'no' ); + $result = add_option( $transient_option, $value, '', 'no' ); $update = false; } else { update_option( $transient_timeout, time() + $expiration ); } } if ( $update ) { - $result = update_option( $transient, $value ); + $result = update_option( $transient_option, $value ); } } } @@ -719,20 +748,24 @@ function set_transient( $transient, $value, $expiration = 0 ) { * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 3.0.0 + * @since 3.6.0 The `$value` and `$expiration` parameters were added. + * @since 4.4.0 The `$transient` parameter was added. * - * @param mixed $value Transient value. - * @param int $expiration Time until expiration in seconds. Default 0. + * @param mixed $value Transient value. + * @param int $expiration Time until expiration in seconds. + * @param string $transient The name of the transient. */ - do_action( 'set_transient_' . $transient, $value, $expiration ); + do_action( 'set_transient_' . $transient, $value, $expiration, $transient ); /** * Fires after the value for a transient has been set. * * @since 3.0.0 + * @since 3.6.0 The `$value` and `$expiration` parameters were added. * * @param string $transient The name of the transient. * @param mixed $value Transient value. - * @param int $expiration Time until expiration in seconds. Default 0. + * @param int $expiration Time until expiration in seconds. */ do_action( 'setted_transient', $transient, $value, $expiration ); } @@ -783,7 +816,7 @@ function wp_user_settings() { } // The cookie is not set in the current browser or the saved value is newer. - $secure = ( 'https' === parse_url( site_url(), PHP_URL_SCHEME ) ); + $secure = ( 'https' === parse_url( admin_url(), PHP_URL_SCHEME ) ); setcookie( 'wp-settings-' . $user_id, $settings, time() + YEAR_IN_SECONDS, SITECOOKIEPATH, null, $secure ); setcookie( 'wp-settings-time-' . $user_id, time(), time() + YEAR_IN_SECONDS, SITECOOKIEPATH, null, $secure ); $_COOKIE['wp-settings-' . $user_id] = $settings; @@ -884,7 +917,7 @@ function get_all_user_settings() { $user_settings = array(); if ( isset( $_COOKIE['wp-settings-' . $user_id] ) ) { - $cookie = preg_replace( '/[^A-Za-z0-9=&_]/', '', $_COOKIE['wp-settings-' . $user_id] ); + $cookie = preg_replace( '/[^A-Za-z0-9=&_-]/', '', $_COOKIE['wp-settings-' . $user_id] ); if ( strpos( $cookie, '=' ) ) { // '=' cannot be 1st char parse_str( $cookie, $user_settings ); @@ -924,8 +957,8 @@ function wp_set_all_user_settings( $user_settings ) { $settings = ''; foreach ( $user_settings as $name => $value ) { - $_name = preg_replace( '/[^A-Za-z0-9_]+/', '', $name ); - $_value = preg_replace( '/[^A-Za-z0-9_]+/', '', $value ); + $_name = preg_replace( '/[^A-Za-z0-9_-]+/', '', $name ); + $_value = preg_replace( '/[^A-Za-z0-9_-]+/', '', $value ); if ( ! empty( $_name ) ) { $settings .= $_name . '=' . $_value . '&'; @@ -956,24 +989,103 @@ function delete_all_user_settings() { } /** - * Retrieve site option value based on name of option. + * Retrieve an option value for the current network based on name of option. + * + * @since 2.8.0 + * @since 4.4.0 The `$use_cache` parameter was deprecated. + * @since 4.4.0 Modified into wrapper for get_network_option() + * + * @see get_network_option() + * + * @param string $option Name of option to retrieve. Expected to not be SQL-escaped. + * @param mixed $default Optional value to return if option doesn't exist. Default false. + * @param bool $deprecated Whether to use cache. Multisite only. Always set to true. + * @return mixed Value set for the option. + */ +function get_site_option( $option, $default = false, $deprecated = true ) { + return get_network_option( null, $option, $default ); +} + +/** + * Add a new option for the current network. + * + * Existing options will not be updated. Note that prior to 3.3 this wasn't the case. * * @since 2.8.0 + * @since 4.4.0 Modified into wrapper for add_network_option() + * + * @see add_network_option() + * + * @param string $option Name of option to add. Expected to not be SQL-escaped. + * @param mixed $value Option value, can be anything. Expected to not be SQL-escaped. + * @return bool False if the option was not added. True if the option was added. + */ +function add_site_option( $option, $value ) { + return add_network_option( null, $option, $value ); +} + +/** + * Removes a option by name for the current network. + * + * @since 2.8.0 + * @since 4.4.0 Modified into wrapper for delete_network_option() + * + * @see delete_network_option() + * + * @param string $option Name of option to remove. Expected to not be SQL-escaped. + * @return bool True, if succeed. False, if failure. + */ +function delete_site_option( $option ) { + return delete_network_option( null, $option ); +} + +/** + * Update the value of an option that was already added for the current network. + * + * @since 2.8.0 + * @since 4.4.0 Modified into wrapper for update_network_option() + * + * @see update_network_option() + * + * @param string $option Name of option. Expected to not be SQL-escaped. + * @param mixed $value Option value. Expected to not be SQL-escaped. + * @return bool False if value was not updated. True if value was updated. + */ +function update_site_option( $option, $value ) { + return update_network_option( null, $option, $value ); +} + +/** + * Retrieve a network's option value based on the option name. + * + * @since 4.4.0 * * @see get_option() * - * @global wpdb $wpdb + * @global wpdb $wpdb + * @global object $current_site * - * @param string $option Name of option to retrieve. Expected to not be SQL-escaped. - * @param mixed $default Optional value to return if option doesn't exist. Default false. - * @param bool $use_cache Whether to use cache. Multisite only. Default true. + * @param int $network_id ID of the network. Can be null to default to the current network ID. + * @param string $option Name of option to retrieve. Expected to not be SQL-escaped. + * @param mixed $default Optional. Value to return if the option doesn't exist. Default false. * @return mixed Value set for the option. */ -function get_site_option( $option, $default = false, $use_cache = true ) { - global $wpdb; +function get_network_option( $network_id, $option, $default = false ) { + global $wpdb, $current_site; + + if ( $network_id && ! is_numeric( $network_id ) ) { + return false; + } + + $network_id = (int) $network_id; + + // Fallback to the current network if a network ID is not specified. + if ( ! $network_id && is_multisite() ) { + $network_id = $current_site->id; + } /** - * Filter an existing site option before it is retrieved. + * Filter an existing network option before it is retrieved. * * The dynamic portion of the hook name, `$option`, refers to the option name. * @@ -982,45 +1094,48 @@ function get_site_option( $option, $default = false, $use_cache = true ) { * * @since 2.9.0 As 'pre_site_option_' . $key * @since 3.0.0 + * @since 4.4.0 The `$option` parameter was added * - * @param mixed $pre_option The default value to return if the option does not exist. + * @param mixed $pre_option The default value to return if the option does not exist. + * @param string $option Option name. */ - $pre = apply_filters( 'pre_site_option_' . $option, false ); + $pre = apply_filters( 'pre_site_option_' . $option, false, $option ); - if ( false !== $pre ) - return $pre; + if ( false !== $pre ) { + return $pre; + } // prevent non-existent options from triggering multiple queries - $notoptions_key = "{$wpdb->siteid}:notoptions"; + $notoptions_key = "$network_id:notoptions"; $notoptions = wp_cache_get( $notoptions_key, 'site-options' ); - if ( isset( $notoptions[$option] ) ) { + if ( isset( $notoptions[ $option ] ) ) { /** - * Filter a specific default site option. + * Filter a specific default network option. * * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 3.4.0 + * @since 4.4.0 The `$option` parameter was added. * - * @param mixed $default The value to return if the site option does not exist - * in the database. + * @param mixed $default The value to return if the site option does not exist + * in the database. + * @param string $option Option name. */ - return apply_filters( 'default_site_option_' . $option, $default ); + return apply_filters( 'default_site_option_' . $option, $default, $option ); } if ( ! is_multisite() ) { - /** This filter is documented in wp-includes/option.php */ - $default = apply_filters( 'default_site_option_' . $option, $default ); - $value = get_option($option, $default); + $default = apply_filters( 'default_site_option_' . $option, $default, $option ); + $value = get_option( $option, $default ); } else { - $cache_key = "{$wpdb->siteid}:$option"; - if ( $use_cache ) - $value = wp_cache_get($cache_key, 'site-options'); + $cache_key = "$network_id:$option"; + $value = wp_cache_get( $cache_key, 'site-options' ); - if ( !isset($value) || (false === $value) ) { - $row = $wpdb->get_row( $wpdb->prepare("SELECT meta_value FROM $wpdb->sitemeta WHERE meta_key = %s AND site_id = %d", $option, $wpdb->siteid ) ); + if ( ! isset( $value ) || false === $value ) { + $row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_value FROM $wpdb->sitemeta WHERE meta_key = %s AND site_id = %d", $option, $network_id ) ); // Has to be get_row instead of get_var because of funkiness with 0, false, null values if ( is_object( $row ) ) { @@ -1029,89 +1144,109 @@ function get_site_option( $option, $default = false, $use_cache = true ) { wp_cache_set( $cache_key, $value, 'site-options' ); } else { if ( ! is_array( $notoptions ) ) { - $notoptions = array(); + $notoptions = array(); } - $notoptions[$option] = true; + $notoptions[ $option ] = true; wp_cache_set( $notoptions_key, $notoptions, 'site-options' ); /** This filter is documented in wp-includes/option.php */ - $value = apply_filters( 'default_site_option_' . $option, $default ); + $value = apply_filters( 'default_site_option_' . $option, $default, $option ); } } } /** - * Filter the value of an existing site option. + * Filter the value of an existing network option. * * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 2.9.0 As 'site_option_' . $key * @since 3.0.0 + * @since 4.4.0 The `$option` parameter was added * - * @param mixed $value Value of site option. + * @param mixed $value Value of network option. + * @param string $option Option name. */ - return apply_filters( 'site_option_' . $option, $value ); + return apply_filters( 'site_option_' . $option, $value, $option ); } /** - * Add a new site option. + * Add a new network option. * - * Existing options will not be updated. Note that prior to 3.3 this wasn't the case. + * Existing options will not be updated. * - * @since 2.8.0 + * @since 4.4.0 * * @see add_option() * - * @global wpdb $wpdb + * @global wpdb $wpdb + * @global object $current_site * - * @param string $option Name of option to add. Expected to not be SQL-escaped. - * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped. + * @param int $network_id ID of the network. Can be null to default to the current network ID. + * @param string $option Name of option to add. Expected to not be SQL-escaped. + * @param mixed $value Option value, can be anything. Expected to not be SQL-escaped. * @return bool False if option was not added and true if option was added. */ -function add_site_option( $option, $value ) { - global $wpdb; +function add_network_option( $network_id, $option, $value ) { + global $wpdb, $current_site; + + if ( $network_id && ! is_numeric( $network_id ) ) { + return false; + } + + $network_id = (int) $network_id; + + // Fallback to the current network if a network ID is not specified. + if ( ! $network_id && is_multisite() ) { + $network_id = $current_site->id; + } wp_protect_special_option( $option ); /** - * Filter the value of a specific site option before it is added. + * Filter the value of a specific network option before it is added. * * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 2.9.0 As 'pre_add_site_option_' . $key * @since 3.0.0 + * @since 4.4.0 The `$option` parameter was added * - * @param mixed $value Value of site option. + * @param mixed $value Value of network option. + * @param string $option Option name. */ - $value = apply_filters( 'pre_add_site_option_' . $option, $value ); + $value = apply_filters( 'pre_add_site_option_' . $option, $value, $option ); - $notoptions_key = "{$wpdb->siteid}:notoptions"; + $notoptions_key = "$network_id:notoptions"; - if ( !is_multisite() ) { + if ( ! is_multisite() ) { $result = add_option( $option, $value ); } else { - $cache_key = "{$wpdb->siteid}:$option"; + $cache_key = "$network_id:$option"; // Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query $notoptions = wp_cache_get( $notoptions_key, 'site-options' ); - if ( ! is_array( $notoptions ) || ! isset( $notoptions[$option] ) ) - if ( false !== get_site_option( $option ) ) + if ( ! is_array( $notoptions ) || ! isset( $notoptions[ $option ] ) ) { + if ( false !== get_network_option( $network_id, $option, false ) ) { return false; + } + } $value = sanitize_option( $option, $value ); $serialized_value = maybe_serialize( $value ); - $result = $wpdb->insert( $wpdb->sitemeta, array('site_id' => $wpdb->siteid, 'meta_key' => $option, 'meta_value' => $serialized_value ) ); + $result = $wpdb->insert( $wpdb->sitemeta, array( 'site_id' => $network_id, 'meta_key' => $option, 'meta_value' => $serialized_value ) ); - if ( ! $result ) + if ( ! $result ) { return false; + } wp_cache_set( $cache_key, $value, 'site-options' ); // This option exists now $notoptions = wp_cache_get( $notoptions_key, 'site-options' ); // yes, again... we need it to be fresh - if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) { - unset( $notoptions[$option] ); + if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) { + unset( $notoptions[ $option ] ); wp_cache_set( $notoptions_key, $notoptions, 'site-options' ); } } @@ -1119,155 +1254,189 @@ function add_site_option( $option, $value ) { if ( $result ) { /** - * Fires after a specific site option has been successfully added. + * Fires after a specific network option has been successfully added. * * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 2.9.0 As "add_site_option_{$key}" * @since 3.0.0 * - * @param string $option Name of site option. - * @param mixed $value Value of site option. + * @param string $option Name of the network option. + * @param mixed $value Value of the network option. */ - do_action( "add_site_option_{$option}", $option, $value ); + do_action( 'add_site_option_' . $option, $option, $value ); /** - * Fires after a site option has been successfully added. + * Fires after a network option has been successfully added. * * @since 3.0.0 * - * @param string $option Name of site option. - * @param mixed $value Value of site option. + * @param string $option Name of the network option. + * @param mixed $value Value of the network option. */ - do_action( "add_site_option", $option, $value ); + do_action( 'add_site_option', $option, $value ); return true; } + return false; } /** - * Removes site option by name. + * Removes a network option by name. * - * @since 2.8.0 + * @since 4.4.0 * * @see delete_option() * - * @global wpdb $wpdb + * @global wpdb $wpdb + * @global object $current_site * - * @param string $option Name of option to remove. Expected to not be SQL-escaped. + * @param int $network_id ID of the network. Can be null to default to the current network ID. + * @param string $option Name of option to remove. Expected to not be SQL-escaped. * @return bool True, if succeed. False, if failure. */ -function delete_site_option( $option ) { - global $wpdb; +function delete_network_option( $network_id, $option ) { + global $wpdb, $current_site; + + if ( $network_id && ! is_numeric( $network_id ) ) { + return false; + } + + $network_id = (int) $network_id; - // ms_protect_special_option( $option ); @todo + // Fallback to the current network if a network ID is not specified. + if ( ! $network_id && is_multisite() ) { + $network_id = $current_site->id; + } /** - * Fires immediately before a specific site option is deleted. + * Fires immediately before a specific network option is deleted. * * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 3.0.0 + * @since 4.4.0 The `$option` parameter was added + * + * @param string $option Option name. */ - do_action( 'pre_delete_site_option_' . $option ); + do_action( 'pre_delete_site_option_' . $option, $option ); - if ( !is_multisite() ) { + if ( ! is_multisite() ) { $result = delete_option( $option ); } else { - $row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d", $option, $wpdb->siteid ) ); - if ( is_null( $row ) || !$row->meta_id ) + $row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d", $option, $network_id ) ); + if ( is_null( $row ) || ! $row->meta_id ) { return false; - $cache_key = "{$wpdb->siteid}:$option"; + } + $cache_key = "$network_id:$option"; wp_cache_delete( $cache_key, 'site-options' ); - $result = $wpdb->delete( $wpdb->sitemeta, array( 'meta_key' => $option, 'site_id' => $wpdb->siteid ) ); + $result = $wpdb->delete( $wpdb->sitemeta, array( 'meta_key' => $option, 'site_id' => $network_id ) ); } if ( $result ) { /** - * Fires after a specific site option has been deleted. + * Fires after a specific network option has been deleted. * * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 2.9.0 As "delete_site_option_{$key}" * @since 3.0.0 * - * @param string $option Name of the site option. + * @param string $option Name of the network option. */ - do_action( "delete_site_option_{$option}", $option ); + do_action( 'delete_site_option_' . $option, $option ); /** - * Fires after a site option has been deleted. + * Fires after a network option has been deleted. * * @since 3.0.0 * - * @param string $option Name of the site option. + * @param string $option Name of the network option. */ - do_action( "delete_site_option", $option ); + do_action( 'delete_site_option', $option ); return true; } + return false; } /** - * Update the value of a site option that was already added. + * Update the value of a network option that was already added. * - * @since 2.8.0 + * @since 4.4.0 * * @see update_option() * - * @global wpdb $wpdb + * @global wpdb $wpdb + * @global object $current_site * - * @param string $option Name of option. Expected to not be SQL-escaped. - * @param mixed $value Option value. Expected to not be SQL-escaped. + * @param int $network_id ID of the network. Can be null to default to the current network ID. + * @param string $option Name of option. Expected to not be SQL-escaped. + * @param mixed $value Option value. Expected to not be SQL-escaped. * @return bool False if value was not updated and true if value was updated. */ -function update_site_option( $option, $value ) { - global $wpdb; +function update_network_option( $network_id, $option, $value ) { + global $wpdb, $current_site; + + if ( $network_id && ! is_numeric( $network_id ) ) { + return false; + } + + $network_id = (int) $network_id; + + // Fallback to the current network if a network ID is not specified. + if ( ! $network_id && is_multisite() ) { + $network_id = $current_site->id; + } wp_protect_special_option( $option ); - $old_value = get_site_option( $option ); + $old_value = get_network_option( $network_id, $option, false ); /** - * Filter a specific site option before its value is updated. + * Filter a specific network option before its value is updated. * * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 2.9.0 As 'pre_update_site_option_' . $key * @since 3.0.0 + * @since 4.4.0 The `$option` parameter was added * - * @param mixed $value New value of site option. - * @param mixed $old_value Old value of site option. + * @param mixed $value New value of the network option. + * @param mixed $old_value Old value of the network option. + * @param string $option Option name. */ - $value = apply_filters( 'pre_update_site_option_' . $option, $value, $old_value ); + $value = apply_filters( 'pre_update_site_option_' . $option, $value, $old_value, $option ); - if ( $value === $old_value ) + if ( $value === $old_value ) { return false; + } - if ( false === $old_value ) - return add_site_option( $option, $value ); + if ( false === $old_value ) { + return add_network_option( $network_id, $option, $value ); + } - $notoptions_key = "{$wpdb->siteid}:notoptions"; + $notoptions_key = "$network_id:notoptions"; $notoptions = wp_cache_get( $notoptions_key, 'site-options' ); - if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) { - unset( $notoptions[$option] ); + if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) { + unset( $notoptions[ $option ] ); wp_cache_set( $notoptions_key, $notoptions, 'site-options' ); } - if ( !is_multisite() ) { + if ( ! is_multisite() ) { $result = update_option( $option, $value ); } else { $value = sanitize_option( $option, $value ); $serialized_value = maybe_serialize( $value ); - $result = $wpdb->update( $wpdb->sitemeta, array( 'meta_value' => $serialized_value ), array( 'site_id' => $wpdb->siteid, 'meta_key' => $option ) ); + $result = $wpdb->update( $wpdb->sitemeta, array( 'meta_value' => $serialized_value ), array( 'site_id' => $network_id, 'meta_key' => $option ) ); if ( $result ) { - $cache_key = "{$wpdb->siteid}:$option"; + $cache_key = "$network_id:$option"; wp_cache_set( $cache_key, $value, 'site-options' ); } } @@ -1275,32 +1444,33 @@ function update_site_option( $option, $value ) { if ( $result ) { /** - * Fires after the value of a specific site option has been successfully updated. + * Fires after the value of a specific network option has been successfully updated. * * The dynamic portion of the hook name, `$option`, refers to the option name. * * @since 2.9.0 As "update_site_option_{$key}" * @since 3.0.0 * - * @param string $option Name of site option. - * @param mixed $value Current value of site option. - * @param mixed $old_value Old value of site option. + * @param string $option Name of the network option. + * @param mixed $value Current value of the network option. + * @param mixed $old_value Old value of the network option. */ - do_action( "update_site_option_{$option}", $option, $value, $old_value ); + do_action( 'update_site_option_' . $option, $option, $value, $old_value ); /** - * Fires after the value of a site option has been successfully updated. + * Fires after the value of a network option has been successfully updated. * * @since 3.0.0 * - * @param string $option Name of site option. - * @param mixed $value Current value of site option. - * @param mixed $old_value Old value of site option. + * @param string $option Name of the network option. + * @param mixed $value Current value of the network option. + * @param mixed $old_value Old value of the network option. */ - do_action( "update_site_option", $option, $value, $old_value ); + do_action( 'update_site_option', $option, $value, $old_value ); return true; } + return false; } @@ -1373,12 +1543,14 @@ function get_site_transient( $transient ) { * returning the passed value instead. * * @since 2.9.0 + * @since 4.4.0 The `$transient` parameter was added. * - * @param mixed $pre_site_transient The default value to return if the site transient does not exist. - * Any value other than false will short-circuit the retrieval - * of the transient, and return the returned value. + * @param mixed $pre_site_transient The default value to return if the site transient does not exist. + * Any value other than false will short-circuit the retrieval + * of the transient, and return the returned value. + * @param string $transient Transient name. */ - $pre = apply_filters( 'pre_site_transient_' . $transient, false ); + $pre = apply_filters( 'pre_site_transient_' . $transient, false, $transient ); if ( false !== $pre ) return $pre; @@ -1409,10 +1581,12 @@ function get_site_transient( $transient ) { * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 2.9.0 + * @since 4.4.0 The `$transient` parameter was added. * - * @param mixed $value Value of site transient. + * @param mixed $value Value of site transient. + * @param string $transient Transient name. */ - return apply_filters( 'site_transient_' . $transient, $value ); + return apply_filters( 'site_transient_' . $transient, $value, $transient ); } /** @@ -1428,7 +1602,7 @@ function get_site_transient( $transient ) { * @param string $transient Transient name. Expected to not be SQL-escaped. Must be * 40 characters or fewer in length. * @param mixed $value Transient value. Expected to not be SQL-escaped. - * @param int $expiration Optional. Time until expiration in seconds. Default 0. + * @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration). * @return bool False if value was not set and true if value was set. */ function set_site_transient( $transient, $value, $expiration = 0 ) { @@ -1439,13 +1613,28 @@ function set_site_transient( $transient, $value, $expiration = 0 ) { * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 3.0.0 + * @since 4.4.0 The `$transient` parameter was added. * - * @param mixed $value Value of site transient. + * @param mixed $value New value of site transient. + * @param string $transient Transient name. */ - $value = apply_filters( 'pre_set_site_transient_' . $transient, $value ); + $value = apply_filters( 'pre_set_site_transient_' . $transient, $value, $transient ); $expiration = (int) $expiration; + /** + * Filter the expiration for a site transient before its value is set. + * + * The dynamic portion of the hook name, `$transient`, refers to the transient name. + * + * @since 4.4.0 + * + * @param int $expiration Time until expiration in seconds. Use 0 for no expiration. + * @param mixed $value New value of site transient. + * @param string $transient Transient name. + */ + $expiration = apply_filters( 'expiration_of_site_transient_' . $transient, $expiration, $value, $transient ); + if ( wp_using_ext_object_cache() ) { $result = wp_cache_set( $transient, $value, 'site-transient', $expiration ); } else { @@ -1469,11 +1658,13 @@ function set_site_transient( $transient, $value, $expiration = 0 ) { * The dynamic portion of the hook name, `$transient`, refers to the transient name. * * @since 3.0.0 + * @since 4.4.0 The `$transient` parameter was added * - * @param mixed $value Site transient value. - * @param int $expiration Time until expiration in seconds. Default 0. + * @param mixed $value Site transient value. + * @param int $expiration Time until expiration in seconds. + * @param string $transient Transient name. */ - do_action( 'set_site_transient_' . $transient, $value, $expiration ); + do_action( 'set_site_transient_' . $transient, $value, $expiration, $transient ); /** * Fires after the value for a site transient has been set. @@ -1482,7 +1673,7 @@ function set_site_transient( $transient, $value, $expiration = 0 ) { * * @param string $transient The name of the site transient. * @param mixed $value Site transient value. - * @param int $expiration Time until expiration in seconds. Default 0. + * @param int $expiration Time until expiration in seconds. */ do_action( 'setted_site_transient', $transient, $value, $expiration ); }