enmi-conf.org: comparison wp/wp-includes/option.php

equal deleted inserted replaced

-:48c4eec2b7e6
+:8c2e4d02f4ef
 	// Distinguish between `false` as a default, and not passing one.
 	$passed_default = func_num_args() > 1;
 	if ( ! wp_installing() ) {
 		$alloptions = wp_load_alloptions();
+		/*
+		 * When getting an option value, we check in the following order for performance:
+		 *
+		 * 1. Check the 'alloptions' cache first to prioritize existing loaded options.
+		 * 2. Check the 'notoptions' cache before a cache lookup or DB hit.
+		 * 3. Check the 'options' cache prior to a DB hit.
+		 * 4. Check the DB for the option and cache it in either the 'options' or 'notoptions' cache.
+		 */
 		if ( isset( $alloptions[ $option ] ) ) {
 			$value = $alloptions[ $option ];
 		} else {
+			// Check for non-existent options first to avoid unnecessary object cache lookups and DB hits.
+			$notoptions = wp_cache_get( 'notoptions', 'options' );
+			if ( ! is_array( $notoptions ) ) {
+				$notoptions = array();
+				wp_cache_set( 'notoptions', $notoptions, 'options' );
+			}
+			if ( isset( $notoptions[ $option ] ) ) {
+				/**
+				 * Filters the default value for an 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.
+				 * @since 4.7.0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value.
+				 *
+				 * @param mixed  $default_value  The default value to return if the option does not exist
+				 *                               in the database.
+				 * @param string $option         Option name.
+				 * @param bool   $passed_default Was `get_option()` passed a default value?
+				 */
+				return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );
+			}
 			$value = wp_cache_get( $option, 'options' );
 			if ( false === $value ) {
-				// Prevent non-existent options from triggering multiple queries.
-				$notoptions = wp_cache_get( 'notoptions', 'options' );
-				// Prevent non-existent `notoptions` key from triggering multiple key lookups.
-				if ( ! is_array( $notoptions ) ) {
-					$notoptions = array();
-					wp_cache_set( 'notoptions', $notoptions, 'options' );
-				} elseif ( isset( $notoptions[ $option ] ) ) {
-					/**
-					 * Filters the default value for an 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.
-					 * @since 4.7.0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value.
-					 *
-					 * @param mixed  $default_value  The default value to return if the option does not exist
-					 *                               in the database.
-					 * @param string $option         Option name.
-					 * @param bool   $passed_default Was `get_option()` passed a default value?
-					 */
-					return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );
-				}
 				$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );
 				// Has to be get_row() instead of get_var() because of funkiness with 0, false, null values.
 				if ( is_object( $row ) ) {
 * This function allows modifying the autoload value for multiple options without changing the actual option value.
 * This is for example recommended for plugin activation and deactivation hooks, to ensure any options exclusively used
 * by the plugin which are generally autoloaded can be set to not autoload when the plugin is inactive.
 *
 * @since 6.4.0
+* @since 6.7.0 The autoload values 'yes' and 'no' are deprecated.
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param array $options Associative array of option names and their autoload values to set. The option names are
-*                       expected to not be SQL-escaped. The autoload values accept 'yes'|true to enable or 'no'|false
+*                       expected to not be SQL-escaped. The autoload values should be boolean values. For backward
-*                       to disable.
+*                       compatibility 'yes' and 'no' are also accepted, though using these values is deprecated.
 * @return array Associative array of all provided $options as keys and boolean values for whether their autoload value
 *               was updated.
 */
 function wp_set_option_autoload_values( array $options ) {
 	global $wpdb;
 		'off' => array(),
 	);
 	$results         = array();
 	foreach ( $options as $option => $autoload ) {
 		wp_protect_special_option( $option ); // Ensure only valid options can be passed.
-		if ( 'off' === $autoload || 'no' === $autoload || false === $autoload ) { // Sanitize autoload value and categorize accordingly.
+		/*
+		 * Sanitize autoload value and categorize accordingly.
+		 * The values 'yes', 'no', 'on', and 'off' are supported for backward compatibility.
+		 */
+		if ( 'off' === $autoload || 'no' === $autoload || false === $autoload ) {
 			$grouped_options['off'][] = $option;
 		} else {
 			$grouped_options['on'][] = $option;
 		}
 		$results[ $option ] = false; // Initialize result value.
 *
 * This is a wrapper for {@see wp_set_option_autoload_values()}, which can be used to set different autoload values for
 * each option at once.
 *
 * @since 6.4.0
+* @since 6.7.0 The autoload values 'yes' and 'no' are deprecated.
 *
 * @see wp_set_option_autoload_values()
 *
-* @param string[]    $options  List of option names. Expected to not be SQL-escaped.
+* @param string[] $options  List of option names. Expected to not be SQL-escaped.
-* @param string|bool $autoload Autoload value to control whether to load the options when WordPress starts up.
+* @param bool     $autoload Autoload value to control whether to load the options when WordPress starts up.
-*                              Accepts 'yes'|true to enable or 'no'|false to disable.
+*                           For backward compatibility 'yes' and 'no' are also accepted, though using these values is
+*                           deprecated.
 * @return array Associative array of all provided $options as keys and boolean values for whether their autoload value
 *               was updated.
 */
 function wp_set_options_autoload( array $options, $autoload ) {
 	return wp_set_option_autoload_values(
 *
 * This is a wrapper for {@see wp_set_option_autoload_values()}, which can be used to set the autoload value for
 * multiple options at once.
 *
 * @since 6.4.0
+* @since 6.7.0 The autoload values 'yes' and 'no' are deprecated.
 *
 * @see wp_set_option_autoload_values()
 *
-* @param string      $option   Name of the option. Expected to not be SQL-escaped.
+* @param string $option   Name of the option. Expected to not be SQL-escaped.
-* @param string|bool $autoload Autoload value to control whether to load the option when WordPress starts up.
+* @param bool   $autoload Autoload value to control whether to load the option when WordPress starts up.
-*                              Accepts 'yes'|true to enable or 'no'|false to disable.
+*                         For backward compatibility 'yes' and 'no' are also accepted, though using these values is
+*                         deprecated.
 * @return bool True if the autoload value was modified, false otherwise.
 */
 function wp_set_option_autoload( $option, $autoload ) {
 	$result = wp_set_option_autoload_values( array( $option => $autoload ) );
 	if ( isset( $result[ $option ] ) ) {
 *
 * @since 6.6.0
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param int      $network_id ID of the network. Can be null to default to the current network ID.
+* @param int|null $network_id ID of the network. Can be null to default to the current network ID.
 * @param string[] $options    An array of option names to be loaded.
 */
 function wp_prime_network_option_caches( $network_id, array $options ) {
 	global $wpdb;
 * This function is designed to work with or without a logged-in user. In terms of security,
 * plugin developers should check the current user's capabilities before updating any options.
 *
 * @since 1.0.0
 * @since 4.2.0 The `$autoload` parameter was added.
+* @since 6.7.0 The autoload values 'yes' and 'no' are deprecated.
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param string    $option   Name of the option to update. Expected to not be SQL-escaped.
 * @param mixed     $value    Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
 * @param bool|null $autoload Optional. Whether to load the option when WordPress starts up.
-*                            Accepts a boolean, or `null` to stick with the initial value or, if no initial value is set,
+*                            Accepts a boolean, or `null` to stick with the initial value or, if no initial value is
-*                            to leave the decision up to default heuristics in WordPress.
+*                            set, to leave the decision up to default heuristics in WordPress.
-*                            For existing options,
+*                            For existing options, `$autoload` can only be updated using `update_option()` if `$value`
-*                            `$autoload` can only be updated using `update_option()` if `$value` is also changed.
+*                            is also changed.
-*                            For backward compatibility 'yes' and 'no' are also accepted.
+*                            For backward compatibility 'yes' and 'no' are also accepted, though using these values is
+*                            deprecated.
 *                            Autoloading too many options can lead to performance problems, especially if the
 *                            options are not frequently used. For options which are accessed across several places
 *                            in the frontend, it is recommended to autoload them, by using true.
 *                            For options which are accessed only on few specific URLs, it is recommended
 *                            to not autoload them, by using false.
 * aren't adding a protected WordPress option. Care should be taken to not name
 * options the same as the ones which are protected.
 *
 * @since 1.0.0
 * @since 6.6.0 The $autoload parameter's default value was changed to null.
+* @since 6.7.0 The autoload values 'yes' and 'no' are deprecated.
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param string    $option     Name of the 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.
 * @param string    $deprecated Optional. Description. Not used anymore.
 * @param bool|null $autoload   Optional. Whether to load the option when WordPress starts up.
-*                              Accepts a boolean, or `null` to leave the decision up to default heuristics in WordPress.
+*                              Accepts a boolean, or `null` to leave the decision up to default heuristics in
-*                              For backward compatibility 'yes' and 'no' are also accepted.
+*                              WordPress. For backward compatibility 'yes' and 'no' are also accepted, though using
+*                              these values is deprecated.
 *                              Autoloading too many options can lead to performance problems, especially if the
 *                              options are not frequently used. For options which are accessed across several places
-*                              in the frontend, it is recommended to autoload them, by using 'yes'|true.
+*                              in the frontend, it is recommended to autoload them, by using true.
 *                              For options which are accessed only on few specific URLs, it is recommended
 *                              to not autoload them, by using false.
 *                              Default is null, which means WordPress will determine the autoload value.
 * @return bool True if the option was added, false otherwise.
 */
 	/**
 	 * Fires after a specific option has been added.
 	 *
 	 * The dynamic portion of the hook name, `$option`, refers to the option name.
 	 *
-	 * @since 2.5.0 As "add_option_{$name}"
+	 * @since 2.5.0 As `add_option_{$name}`
 	 * @since 3.0.0
 	 *
 	 * @param string $option Name of the option to add.
 	 * @param mixed  $value  Value of the option.
 	 */
 				wp_cache_set( 'alloptions', $alloptions, 'options' );
 			}
 		} else {
 			wp_cache_delete( $option, 'options' );
 		}
+		$notoptions = wp_cache_get( 'notoptions', 'options' );
+		if ( ! is_array( $notoptions ) ) {
+			$notoptions = array();
+		}
+		$notoptions[ $option ] = true;
+		wp_cache_set( 'notoptions', $notoptions, 'options' );
 	}
 	if ( $result ) {
 		/**
 * decision could be made.
 *
 * @since 6.6.0
 * @access private
 *
-* @param string $option          The name of the option.
+* @param string    $option           The name of the option.
-* @param mixed $value            The value of the option to check its autoload value.
+* @param mixed     $value            The value of the option to check its autoload value.
-* @param mixed $serialized_value The serialized value of the option to check its autoload value.
+* @param mixed     $serialized_value The serialized value of the option to check its autoload value.
-* @param bool|null $autoload     The autoload value to check.
+* @param bool|null $autoload         The autoload value to check.
-*                                Accepts 'on'|true to enable or 'off'|false to disable, or
+*                                    Accepts 'on'|true to enable or 'off'|false to disable, or
-*                                'auto-on', 'auto-off', or 'auto' for internal purposes.
+*                                    'auto-on', 'auto-off', or 'auto' for internal purposes.
-*                                Any other autoload value will be forced to either 'auto-on',
+*                                    Any other autoload value will be forced to either 'auto-on',
-*                                'auto-off', or 'auto'.
+*                                    'auto-off', or 'auto'.
-*                                'yes' and 'no' are supported for backward compatibility.
+*                                    'yes' and 'no' are supported for backward compatibility.
 * @return string Returns the original $autoload value if explicit, or 'auto-on', 'auto-off',
 *                or 'auto' depending on default heuristics.
 */
 function wp_determine_option_autoload_value( $option, $value, $serialized_value, $autoload ) {
 		do_action( "set_transient_{$transient}", $value, $expiration, $transient );
 		/**
 		 * Fires after the value for a transient has been set.
 		 *
-		 * @since 3.0.0
+		 * @since 6.8.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.
 		 */
-		do_action( 'setted_transient', $transient, $value, $expiration );
+		do_action( 'set_transient', $transient, $value, $expiration );
+		/**
+		 * Fires after the transient is set.
+		 *
+		 * @since 3.0.0
+		 * @since 3.6.0 The `$value` and `$expiration` parameters were added.
+		 * @deprecated 6.8.0 Use {@see 'set_transient'} instead.
+		 *
+		 * @param string $transient  The name of the transient.
+		 * @param mixed  $value      Transient value.
+		 * @param int    $expiration Time until expiration in seconds.
+		 */
+		do_action_deprecated( 'setted_transient', array( $transient, $value, $expiration ), '6.8.0', 'set_transient' );
 	}
 	return $result;
 }
 		if ( $cookie === $settings ) {
 			return;
 		}
 		$last_saved = (int) get_user_option( 'user-settings-time', $user_id );
-		$current    = isset( $_COOKIE[ 'wp-settings-time-' . $user_id ] ) ? preg_replace( '/[^0-9]/', '', $_COOKIE[ 'wp-settings-time-' . $user_id ] ) : 0;
+		$current    = 0;
+		if ( isset( $_COOKIE[ 'wp-settings-time-' . $user_id ] ) ) {
+			$current = (int) preg_replace( '/[^0-9]/', '', $_COOKIE[ 'wp-settings-time-' . $user_id ] );
+		}
 		// The cookie is newer than the saved value. Update the user_option and leave the cookie as-is.
 		if ( $current > $last_saved ) {
 			update_user_option( $user_id, 'user-settings', $cookie, false );
 			update_user_option( $user_id, 'user-settings-time', time() - 5, false );
 *
 * @see get_option()
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param int    $network_id    ID of the network. Can be null to default to the current network ID.
+* @param int|null $network_id    ID of the network. Can be null to default to the current network ID.
-* @param string $option        Name of the option to retrieve. Expected to not be SQL-escaped.
+* @param string   $option        Name of the option to retrieve. Expected to not be SQL-escaped.
-* @param mixed  $default_value Optional. Value to return if the option doesn't exist. Default false.
+* @param mixed    $default_value Optional. Value to return if the option doesn't exist. Default false.
 * @return mixed Value set for the option.
 */
 function get_network_option( $network_id, $option, $default_value = false ) {
 	global $wpdb;
 	 * @since 3.0.0
 	 * @since 4.4.0 The `$option` parameter was added.
 	 * @since 4.7.0 The `$network_id` parameter was added.
 	 * @since 4.9.0 The `$default_value` parameter was added.
 	 *
-	 * @param mixed  $pre_option    The value to return instead of the option value. This differs from
+	 * @param mixed  $pre_site_option The value to return instead of the option value. This differs from
-	 *                              `$default_value`, which is used as the fallback value in the event
+	 *                                `$default_value`, which is used as the fallback value in the event
-	 *                              the option doesn't exist elsewhere in get_network_option().
+	 *                                the option doesn't exist elsewhere in get_network_option().
-	 *                              Default false (to skip past the short-circuit).
+	 *                                Default false (to skip past the short-circuit).
-	 * @param string $option        Option name.
+	 * @param string $option          Option name.
-	 * @param int    $network_id    ID of the network.
+	 * @param int    $network_id      ID of the network.
-	 * @param mixed  $default_value The fallback value to return if the option does not exist.
+	 * @param mixed  $default_value   The fallback value to return if the option does not exist.
-	 *                              Default false.
+	 *                                Default false.
 	 */
 	$pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default_value );
 	if ( false !== $pre ) {
 		return $pre;
 *
 * @see add_option()
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param int    $network_id ID of the network. Can be null to default to the current network ID.
+* @param int|null $network_id ID of the network. Can be null to default to the current network ID.
-* @param string $option     Name of the option to add. Expected to not be SQL-escaped.
+* @param string   $option     Name of the option to add. Expected to not be SQL-escaped.
-* @param mixed  $value      Option value, can be anything. Expected to not be SQL-escaped.
+* @param mixed    $value      Option value, can be anything. Expected to not be SQL-escaped.
 * @return bool True if the option was added, false otherwise.
 */
 function add_network_option( $network_id, $option, $value ) {
 	global $wpdb;
 *
 * @see delete_option()
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param int    $network_id ID of the network. Can be null to default to the current network ID.
+* @param int|null $network_id ID of the network. Can be null to default to the current network ID.
-* @param string $option     Name of the option to delete. Expected to not be SQL-escaped.
+* @param string   $option     Name of the option to delete. Expected to not be SQL-escaped.
 * @return bool True if the option was deleted, false otherwise.
 */
 function delete_network_option( $network_id, $option ) {
 	global $wpdb;
 			array(
 				'meta_key' => $option,
 				'site_id'  => $network_id,
 			)
 		);
+		if ( $result ) {
+			$notoptions_key = "$network_id:notoptions";
+			$notoptions     = wp_cache_get( $notoptions_key, 'site-options' );
+			if ( ! is_array( $notoptions ) ) {
+				$notoptions = array();
+			}
+			$notoptions[ $option ] = true;
+			wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
+		}
 	}
 	if ( $result ) {
 		/**
 *
 * @see update_option()
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param int    $network_id ID of the network. Can be null to default to the current network ID.
+* @param int|null $network_id ID of the network. Can be null to default to the current network ID.
-* @param string $option     Name of the option. Expected to not be SQL-escaped.
+* @param string   $option     Name of the option. Expected to not be SQL-escaped.
-* @param mixed  $value      Option value. Expected to not be SQL-escaped.
+* @param mixed    $value      Option value. Expected to not be SQL-escaped.
 * @return bool True if the value was updated, false otherwise.
 */
 function update_network_option( $network_id, $option, $value ) {
 	global $wpdb;
 		do_action( "set_site_transient_{$transient}", $value, $expiration, $transient );
 		/**
 		 * Fires after the value for a site transient has been set.
 		 *
-		 * @since 3.0.0
+		 * @since 6.8.0
 		 *
 		 * @param string $transient  The name of the site transient.
 		 * @param mixed  $value      Site transient value.
 		 * @param int    $expiration Time until expiration in seconds.
 		 */
-		do_action( 'setted_site_transient', $transient, $value, $expiration );
+		do_action( 'set_site_transient', $transient, $value, $expiration );
+		/**
+		 * Fires after the value for a site transient has been set.
+		 *
+		 * @since 3.0.0
+		 * @deprecated 6.8.0 Use {@see 'set_site_transient'} instead.
+		 *
+		 * @param string $transient  The name of the site transient.
+		 * @param mixed  $value      Site transient value.
+		 * @param int    $expiration Time until expiration in seconds.
+		 */
+		do_action_deprecated( 'setted_site_transient', array( $transient, $value, $expiration ), '6.8.0', 'set_site_transient' );
 	}
 	return $result;
 }

changeset 22	8c2e4d02f4ef
parent 21	48c4eec2b7e6