WordPress 4.2.4-scripts

[autoinstalls/wordpress.git] / wp-includes / option.php

diff --git a/wp-includes/option.php b/wp-includes/option.php
index c6417dbeade3867278f746c8f6e5b29c62909ae3..b7725fc47261713fe6768f0c1e90a030d023a634 100644 (file)
--- a/wp-includes/option.php
+++ b/wp-includes/option.php
@@ -32,7 +32,7 @@ function get_option( $option, $default = false ) {
        /**
         * Filter the value of an existing option before it is retrieved.
         *
        /**
         * Filter the value of an existing option before it is retrieved.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * The dynamic portion of the hook name, `$option`, refers to the option name.

         *
         * Passing a truthy value to the filter will short-circuit retrieving
         * the option value, returning the passed value instead.
         *
         * Passing a truthy value to the filter will short-circuit retrieving
         * the option value, returning the passed value instead.


@@ -52,20 +52,19 @@ function get_option( $option, $default = false ) {
        if ( ! defined( 'WP_INSTALLING' ) ) {
                // prevent non-existent options from triggering multiple queries
                $notoptions = wp_cache_get( 'notoptions', 'options' );
        if ( ! defined( 'WP_INSTALLING' ) ) {
                // prevent non-existent options from triggering multiple queries
                $notoptions = wp_cache_get( 'notoptions', 'options' );

-               if ( isset( $notoptions[$option] ) )
-
+               if ( isset( $notoptions[ $option ] ) ) {

                        /**
                         * Filter the default value for an option.
                         *
                        /**
                         * Filter the default value for an option.
                         *

-                        * The dynamic portion of the hook name, $option, refers
-                        * to the option name.
+                        * The dynamic portion of the hook name, `$option`, refers to the option name.

                         *
                         * @since 3.4.0
                         *
                         *
                         * @since 3.4.0
                         *

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

                         */
                        return apply_filters( 'default_option_' . $option, $default );
                         */
                        return apply_filters( 'default_option_' . $option, $default );

+               }

 
                $alloptions = wp_load_alloptions();
 
 
                $alloptions = wp_load_alloptions();
 


@@ -112,7 +111,7 @@ function get_option( $option, $default = false ) {
        /**
         * Filter the value of an existing option.
         *
        /**
         * Filter the value of an existing option.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * The dynamic portion of the hook name, `$option`, refers to the option name.

         *
         * @since 1.5.0 As 'option_' . $setting
         * @since 3.0.0
         *
         * @since 1.5.0 As 'option_' . $setting
         * @since 3.0.0


@@ -141,7 +140,6 @@ function wp_protect_special_option( $option ) {
 /**
  * Print option value after sanitizing for forms.
  *
 /**
  * Print option value after sanitizing for forms.
  *

- * @uses attr Sanitizes value.

  * @since 1.5.0
  *
  * @param string $option Option name.
  * @since 1.5.0
  *
  * @param string $option Option name.


@@ -223,12 +221,17 @@ function wp_load_core_site_options( $site_id = null ) {
  * to set whether an option is autoloaded, then you need to use the add_option().
  *
  * @since 1.0.0
  * to set whether an option is autoloaded, then you need to use the add_option().
  *
  * @since 1.0.0

- *
- * @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.
+ * @since 4.2.0 The `$autoload` parameter was added.
+ *
+ * @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.
+ * @param string|bool $autoload Optional. Whether to load the option when WordPress starts up. For existing options,
+ *                              `$autoload` can only be updated using `update_option()` if `$value` is also changed.
+ *                              Accepts 'yes' or true to enable, 'no' or false to disable. For non-existent options,
+ *                              the default value is 'yes'.

  * @return bool False if value was not updated and true if value was updated.
  */
  * @return bool False if value was not updated and true if value was updated.
  */

-function update_option( $option, $value ) {
+function update_option( $option, $value, $autoload = null ) {

        global $wpdb;
 
        $option = trim($option);
        global $wpdb;
 
        $option = trim($option);


@@ -246,7 +249,7 @@ function update_option( $option, $value ) {
        /**
         * Filter a specific option before its value is (maybe) serialized and updated.
         *
        /**
         * Filter a specific option before its value is (maybe) serialized and updated.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * The dynamic portion of the hook name, `$option`, refers to the option name.

         *
         * @since 2.6.0
         *
         *
         * @since 2.6.0
         *


@@ -270,8 +273,15 @@ function update_option( $option, $value ) {
        if ( $value === $old_value )
                return false;
 
        if ( $value === $old_value )
                return false;
 

-       if ( false === $old_value )
-               return add_option( $option, $value );
+       /** This filter is documented in wp-includes/option.php */
+       if ( apply_filters( 'default_option_' . $option, false ) === $old_value ) {
+               // Default setting for new options is 'yes'.
+               if ( null === $autoload ) {
+                       $autoload = 'yes';
+               }
+
+               return add_option( $option, $value, '', $autoload );
+       }

 
        $serialized_value = maybe_serialize( $value );
 
 
        $serialized_value = maybe_serialize( $value );
 


@@ -286,7 +296,15 @@ function update_option( $option, $value ) {
         */
        do_action( 'update_option', $option, $old_value, $value );
 
         */
        do_action( 'update_option', $option, $old_value, $value );
 

-       $result = $wpdb->update( $wpdb->options, array( 'option_value' => $serialized_value ), array( 'option_name' => $option ) );
+       $update_args = array(
+               'option_value' => $serialized_value,
+       );
+
+       if ( null !== $autoload ) {
+               $update_args['autoload'] = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes';
+       }
+
+       $result = $wpdb->update( $wpdb->options, $update_args, array( 'option_name' => $option ) );

        if ( ! $result )
                return false;
 
        if ( ! $result )
                return false;
 


@@ -309,7 +327,7 @@ function update_option( $option, $value ) {
        /**
         * Fires after the value of a specific option has been successfully updated.
         *
        /**
         * Fires after the value of a specific option has been successfully updated.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * The dynamic portion of the hook name, `$option`, refers to the option name.

         *
         * @since 2.0.1
         *
         *
         * @since 2.0.1
         *


@@ -345,10 +363,11 @@ function update_option( $option, $value ) {
  *
  * @since 1.0.0
  *
  *
  * @since 1.0.0
  *

- * @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.
- * @param mixed $deprecated Optional. Description. Not used anymore.
- * @param bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up.
+ * @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.
+ * @param string         $deprecated  Optional. Description. Not used anymore.
+ * @param string|bool    $autoload    Optional. Whether to load the option when WordPress starts up.
+ *                                    Default is enabled. Accepts 'no' to disable for legacy reasons.

  * @return bool False if option was not added and true if option was added.
  */
 function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {
  * @return bool False if option was not added and true if option was added.
  */
 function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {


@@ -371,11 +390,12 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' )
        // 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', 'options' );
        if ( !is_array( $notoptions ) || !isset( $notoptions[$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', 'options' );
        if ( !is_array( $notoptions ) || !isset( $notoptions[$option] ) )

-               if ( false !== get_option( $option ) )
+               /** This filter is documented in wp-includes/option.php */
+               if ( apply_filters( 'default_option_' . $option, false ) !== get_option( $option ) )

                        return false;
 
        $serialized_value = maybe_serialize( $value );
                        return false;
 
        $serialized_value = maybe_serialize( $value );

-       $autoload = ( 'no' === $autoload ) ? 'no' : 'yes';
+       $autoload = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes';

 
        /**
         * Fires before an option is added.
 
        /**
         * Fires before an option is added.


@@ -411,7 +431,7 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' )
        /**
         * Fires after a specific option has been added.
         *
        /**
         * Fires after a specific option has been added.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * The dynamic portion of the hook name, `$option`, refers to the option name.

         *
         * @since 2.5.0 As "add_option_{$name}"
         * @since 3.0.0
         *
         * @since 2.5.0 As "add_option_{$name}"
         * @since 3.0.0


@@ -481,7 +501,7 @@ function delete_option( $option ) {
                /**
                 * Fires after a specific option has been deleted.
                 *
                /**
                 * Fires after a specific option has been deleted.
                 *

-                * The dynamic portion of the hook name, $option, refers to the option name.
+                * The dynamic portion of the hook name, `$option`, refers to the option name.

                 *
                 * @since 3.0.0
                 *
                 *
                 * @since 3.0.0
                 *


@@ -515,7 +535,7 @@ function delete_transient( $transient ) {
        /**
         * Fires immediately before a specific transient is deleted.
         *
        /**
         * Fires immediately before a specific transient is deleted.
         *

-        * The dynamic portion of the hook name, $transient, refers to the transient name.
+        * The dynamic portion of the hook name, `$transient`, refers to the transient name.

         *
         * @since 3.0.0
         *
         *
         * @since 3.0.0
         *


@@ -564,7 +584,7 @@ function get_transient( $transient ) {
        /**
         * Filter the value of an existing transient.
         *
        /**
         * Filter the value of an existing transient.
         *

-        * The dynamic portion of the hook name, $transient, refers to the transient name.
+        * The dynamic portion of the hook name, `$transient`, refers to the transient name.

         *
         * Passing a truthy value to the filter will effectively short-circuit retrieval
         * of the transient, returning the passed value instead.
         *
         * Passing a truthy value to the filter will effectively short-circuit retrieval
         * of the transient, returning the passed value instead.


@@ -603,7 +623,7 @@ function get_transient( $transient ) {
        /**
         * Filter an existing transient's value.
         *
        /**
         * Filter an existing transient's value.
         *

-        * The dynamic portion of the hook name, $transient, refers to the transient name.
+        * The dynamic portion of the hook name, `$transient`, refers to the transient name.

         *
         * @since 2.8.0
         *
         *
         * @since 2.8.0
         *


@@ -629,18 +649,20 @@ function get_transient( $transient ) {
  */
 function set_transient( $transient, $value, $expiration = 0 ) {
 
  */
 function set_transient( $transient, $value, $expiration = 0 ) {
 

+       $expiration = (int) $expiration;
+

        /**
         * Filter a specific transient before its value is set.
         *
        /**
         * Filter a specific transient before its value is set.
         *

-        * The dynamic portion of the hook name, $transient, refers to the transient name.
+        * The dynamic portion of the hook name, `$transient`, refers to the transient name.

         *
         * @since 3.0.0
         *
         * @since 3.0.0

+        * @since 4.2.0 Added `$expiration` parameter.

         *
         *

-        * @param mixed $value New value of transient.
+        * @param mixed $value      New value of transient.
+        * @param int   $expiration Time until expiration in seconds.

         */
         */

-       $value = apply_filters( 'pre_set_transient_' . $transient, $value );
-
-       $expiration = (int) $expiration;
+       $value = apply_filters( 'pre_set_transient_' . $transient, $value, $expiration );

 
        if ( wp_using_ext_object_cache() ) {
                $result = wp_cache_set( $transient, $value, 'transient', $expiration );
 
        if ( wp_using_ext_object_cache() ) {
                $result = wp_cache_set( $transient, $value, 'transient', $expiration );


@@ -679,7 +701,7 @@ function set_transient( $transient, $value, $expiration = 0 ) {
                /**
                 * Fires after the value for a specific transient has been set.
                 *
                /**
                 * Fires after the value for a specific transient has been set.
                 *

-                * The dynamic portion of the hook name, $transient, refers to the transient name.
+                * The dynamic portion of the hook name, `$transient`, refers to the transient name.

                 *
                 * @since 3.0.0
                 *
                 *
                 * @since 3.0.0
                 *


@@ -777,7 +799,7 @@ function get_user_setting( $name, $default = false ) {
  *
  * @param string $name The name of the setting.
  * @param string $value The value for the setting.
  *
  * @param string $name The name of the setting.
  * @param string $value The value for the setting.

- * @return bool true if set successfully/false if not.
+ * @return null|bool true if set successfully/false if not.

  */
 function set_user_setting( $name, $value ) {
 
  */
 function set_user_setting( $name, $value ) {
 


@@ -799,8 +821,8 @@ function set_user_setting( $name, $value ) {
  *
  * @since 2.7.0
  *
  *
  * @since 2.7.0
  *

- * @param mixed $names The name or array of names of the setting to be deleted.
- * @return bool true if deleted successfully/false if not.
+ * @param string $names The name or array of names of the setting to be deleted.
+ * @return null|bool true if deleted successfully/false if not.

  */
 function delete_user_setting( $names ) {
 
  */
 function delete_user_setting( $names ) {
 


@@ -870,7 +892,7 @@ function get_all_user_settings() {
  * @since 2.8.0
  *
  * @param array $user_settings
  * @since 2.8.0
  *
  * @param array $user_settings

- * @return bool
+ * @return null|bool

  */
 function wp_set_all_user_settings( $user_settings ) {
        global $_updated_user_settings;
  */
 function wp_set_all_user_settings( $user_settings ) {
        global $_updated_user_settings;


@@ -934,7 +956,7 @@ function get_site_option( $option, $default = false, $use_cache = true ) {
        /**
         * Filter an existing site option before it is retrieved.
         *
        /**
         * Filter an existing site option before it is retrieved.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * The dynamic portion of the hook name, `$option`, refers to the option name.

         *
         * Passing a truthy value to the filter will effectively short-circuit retrieval,
         * returning the passed value instead.
         *
         * Passing a truthy value to the filter will effectively short-circuit retrieval,
         * returning the passed value instead.


@@ -958,7 +980,7 @@ function get_site_option( $option, $default = false, $use_cache = true ) {
                /**
                 * Filter a specific default site option.
                 *
                /**
                 * Filter a specific default site option.
                 *

-                * The dynamic portion of the hook name, $option, refers to the option name.
+                * The dynamic portion of the hook name, `$option`, refers to the option name.

                 *
                 * @since 3.4.0
                 *
                 *
                 * @since 3.4.0
                 *


@@ -999,7 +1021,7 @@ function get_site_option( $option, $default = false, $use_cache = true ) {
        /**
         * Filter the value of an existing site option.
         *
        /**
         * Filter the value of an existing site option.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * 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 2.9.0 As 'site_option_' . $key
         * @since 3.0.0


@@ -1030,7 +1052,7 @@ function add_site_option( $option, $value ) {
        /**
         * Filter the value of a specific site option before it is added.
         *
        /**
         * Filter the value of a specific site option before it is added.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * 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 2.9.0 As 'pre_add_site_option_' . $key
         * @since 3.0.0


@@ -1075,7 +1097,7 @@ function add_site_option( $option, $value ) {
                /**
                 * Fires after a specific site option has been successfully added.
                 *
                /**
                 * Fires after a specific site option has been successfully added.
                 *

-                * The dynamic portion of the hook name, $option, refers to the option name.
+                * 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
                 *
                 * @since 2.9.0 As "add_site_option_{$key}"
                 * @since 3.0.0


@@ -1118,7 +1140,7 @@ function delete_site_option( $option ) {
        /**
         * Fires immediately before a specific site option is deleted.
         *
        /**
         * Fires immediately before a specific site option is deleted.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * The dynamic portion of the hook name, `$option`, refers to the option name.

         *
         * @since 3.0.0
         */
         *
         * @since 3.0.0
         */


@@ -1141,7 +1163,7 @@ function delete_site_option( $option ) {
                /**
                 * Fires after a specific site option has been deleted.
                 *
                /**
                 * Fires after a specific site option has been deleted.
                 *

-                * The dynamic portion of the hook name, $option, refers to the option name.
+                * 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
                 *
                 * @since 2.9.0 As "delete_site_option_{$key}"
                 * @since 3.0.0


@@ -1185,7 +1207,7 @@ function update_site_option( $option, $value ) {
        /**
         * Filter a specific site option before its value is updated.
         *
        /**
         * Filter a specific site option before its value is updated.
         *

-        * The dynamic portion of the hook name, $option, refers to the option name.
+        * 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 2.9.0 As 'pre_update_site_option_' . $key
         * @since 3.0.0


@@ -1227,7 +1249,7 @@ function update_site_option( $option, $value ) {
                /**
                 * Fires after the value of a specific site option has been successfully updated.
                 *
                /**
                 * Fires after the value of a specific site option has been successfully updated.
                 *

-                * The dynamic portion of the hook name, $option, refers to the option name.
+                * 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
                 *
                 * @since 2.9.0 As "update_site_option_{$key}"
                 * @since 3.0.0


@@ -1267,7 +1289,7 @@ function delete_site_transient( $transient ) {
        /**
         * Fires immediately before a specific site transient is deleted.
         *
        /**
         * Fires immediately before a specific site transient is deleted.
         *

-        * The dynamic portion of the hook name, $transient, refers to the transient name.
+        * The dynamic portion of the hook name, `$transient`, refers to the transient name.

         *
         * @since 3.0.0
         *
         *
         * @since 3.0.0
         *


@@ -1317,7 +1339,7 @@ function get_site_transient( $transient ) {
        /**
         * Filter the value of an existing site transient.
         *
        /**
         * Filter the value of an existing site transient.
         *

-        * The dynamic portion of the hook name, $transient, refers to the transient name.
+        * The dynamic portion of the hook name, `$transient`, refers to the transient name.

         *
         * Passing a truthy value to the filter will effectively short-circuit retrieval,
         * returning the passed value instead.
         *
         * Passing a truthy value to the filter will effectively short-circuit retrieval,
         * returning the passed value instead.


@@ -1356,7 +1378,7 @@ function get_site_transient( $transient ) {
        /**
         * Filter the value of an existing site transient.
         *
        /**
         * Filter the value of an existing site transient.
         *

-        * The dynamic portion of the hook name, $transient, refers to the transient name.
+        * The dynamic portion of the hook name, `$transient`, refers to the transient name.

         *
         * @since 2.9.0
         *
         *
         * @since 2.9.0
         *


@@ -1386,7 +1408,7 @@ function set_site_transient( $transient, $value, $expiration = 0 ) {
        /**
         * Filter the value of a specific site transient before it is set.
         *
        /**
         * Filter the value of a specific site transient before it is set.
         *

-        * The dynamic portion of the hook name, $transient, refers to the transient name.
+        * The dynamic portion of the hook name, `$transient`, refers to the transient name.

         *
         * @since 3.0.0
         *
         *
         * @since 3.0.0
         *


@@ -1416,7 +1438,7 @@ function set_site_transient( $transient, $value, $expiration = 0 ) {
                /**
                 * Fires after the value for a specific site transient has been set.
                 *
                /**
                 * Fires after the value for a specific site transient has been set.
                 *

-                * The dynamic portion of the hook name, $transient, refers to the transient name.
+                * The dynamic portion of the hook name, `$transient`, refers to the transient name.

                 *
                 * @since 3.0.0
                 *
                 *
                 * @since 3.0.0
                 *