]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/option.php
WordPress 4.1.4-scripts
[autoinstalls/wordpress.git] / wp-includes / option.php
index 4cc8c28fa01e3e788bc9aa7016f77dca07a18b08..6134606471347db74f641f73250885c9de53caa3 100644 (file)
@@ -32,7 +32,7 @@ function get_option( $option, $default = false ) {
        /**
         * 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.
@@ -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 ( isset( $notoptions[$option] ) )
-
+               if ( isset( $notoptions[ $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
                         *
-                        * @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 );
+               }
 
                $alloptions = wp_load_alloptions();
 
@@ -112,7 +111,7 @@ function get_option( $option, $default = false ) {
        /**
         * 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
@@ -141,7 +140,6 @@ function wp_protect_special_option( $option ) {
 /**
  * Print option value after sanitizing for forms.
  *
- * @uses attr Sanitizes value.
  * @since 1.5.0
  *
  * @param string $option Option name.
@@ -246,7 +244,7 @@ function update_option( $option, $value ) {
        /**
         * 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
         *
@@ -309,7 +307,7 @@ function update_option( $option, $value ) {
        /**
         * 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
         *
@@ -345,10 +343,10 @@ function update_option( $option, $value ) {
  *
  * @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. Default is enabled. Whether to load the option when WordPress starts up.
  * @return bool False if option was not added and true if option was added.
  */
 function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {
@@ -411,7 +409,7 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' )
        /**
         * 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
@@ -481,7 +479,7 @@ function delete_option( $option ) {
                /**
                 * 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
                 *
@@ -515,7 +513,7 @@ function delete_transient( $transient ) {
        /**
         * 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
         *
@@ -551,20 +549,20 @@ function delete_transient( $transient ) {
 /**
  * Get the value of a transient.
  *
- * If the transient does not exist or does not have a value, then the return value
- * will be false.
+ * If the transient does not exist, does not have a value, or has expired,
+ * then the return value will be false.
  *
  * @since 2.8.0
  *
- * @param string $transient Transient name. Expected to not be SQL-escaped
- * @return mixed Value of transient
+ * @param string $transient Transient name. Expected to not be SQL-escaped.
+ * @return mixed Value of 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.
+        * 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.
@@ -603,7 +601,7 @@ function get_transient( $transient ) {
        /**
         * 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
         *
@@ -620,9 +618,11 @@ function get_transient( $transient ) {
  *
  * @since 2.8.0
  *
- * @param string $transient Transient name. Expected to not be SQL-escaped.
- * @param mixed $value Transient value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
- * @param int $expiration Time until expiration in seconds, default 0
+ * @param string $transient  Transient name. Expected to not be SQL-escaped. Must be
+ *                           45 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.
  * @return bool False if value was not set and true if value was set.
  */
 function set_transient( $transient, $value, $expiration = 0 ) {
@@ -630,7 +630,7 @@ function set_transient( $transient, $value, $expiration = 0 ) {
        /**
         * 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
         *
@@ -677,7 +677,7 @@ function set_transient( $transient, $value, $expiration = 0 ) {
                /**
                 * 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
                 *
@@ -711,17 +711,17 @@ function set_transient( $transient, $value, $expiration = 0 ) {
  */
 function wp_user_settings() {
 
-       if ( ! is_admin() )
-               return;
-
-       if ( defined('DOING_AJAX') )
+       if ( ! is_admin() || defined( 'DOING_AJAX' ) ) {
                return;
+       }
 
-       if ( ! $user_id = get_current_user_id() )
+       if ( ! $user_id = get_current_user_id() ) {
                return;
+       }
 
-       if ( is_super_admin() && ! is_user_member_of_blog() )
+       if ( is_super_admin() && ! is_user_member_of_blog() ) {
                return;
+       }
 
        $settings = (string) get_user_option( 'user-settings', $user_id );
 
@@ -744,8 +744,9 @@ function wp_user_settings() {
        }
 
        // The cookie is not set in the current browser or the saved value is newer.
-       setcookie( 'wp-settings-' . $user_id, $settings, time() + YEAR_IN_SECONDS, SITECOOKIEPATH );
-       setcookie( 'wp-settings-time-' . $user_id, time(), time() + YEAR_IN_SECONDS, SITECOOKIEPATH );
+       $secure = ( 'https' === parse_url( site_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;
 }
 
@@ -774,12 +775,13 @@ function get_user_setting( $name, $default = false ) {
  *
  * @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 ) {
 
-       if ( headers_sent() )
+       if ( headers_sent() ) {
                return false;
+       }
 
        $all_user_settings = get_all_user_settings();
        $all_user_settings[$name] = $value;
@@ -795,13 +797,14 @@ function set_user_setting( $name, $value ) {
  *
  * @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 ) {
 
-       if ( headers_sent() )
+       if ( headers_sent() ) {
                return false;
+       }
 
        $all_user_settings = get_all_user_settings();
        $names = (array) $names;
@@ -814,8 +817,9 @@ function delete_user_setting( $names ) {
                }
        }
 
-       if ( $deleted )
+       if ( $deleted ) {
                return wp_set_all_user_settings( $all_user_settings );
+       }
 
        return false;
 }
@@ -830,23 +834,28 @@ function delete_user_setting( $names ) {
 function get_all_user_settings() {
        global $_updated_user_settings;
 
-       if ( ! $user_id = get_current_user_id() )
+       if ( ! $user_id = get_current_user_id() ) {
                return array();
+       }
 
-       if ( isset( $_updated_user_settings ) && is_array( $_updated_user_settings ) )
+       if ( isset( $_updated_user_settings ) && is_array( $_updated_user_settings ) ) {
                return $_updated_user_settings;
+       }
 
        $user_settings = array();
+
        if ( isset( $_COOKIE['wp-settings-' . $user_id] ) ) {
                $cookie = preg_replace( '/[^A-Za-z0-9=&_]/', '', $_COOKIE['wp-settings-' . $user_id] );
 
-               if ( $cookie && strpos( $cookie, '=' ) ) // '=' cannot be 1st char
+               if ( strpos( $cookie, '=' ) ) { // '=' cannot be 1st char
                        parse_str( $cookie, $user_settings );
-
+               }
        } else {
                $option = get_user_option( 'user-settings', $user_id );
-               if ( $option && is_string($option) )
+
+               if ( $option && is_string( $option ) ) {
                        parse_str( $option, $user_settings );
+               }
        }
 
        $_updated_user_settings = $user_settings;
@@ -859,27 +868,30 @@ function get_all_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;
 
-       if ( ! $user_id = get_current_user_id() )
+       if ( ! $user_id = get_current_user_id() ) {
                return false;
+       }
 
-       if ( is_super_admin() && ! is_user_member_of_blog() )
+       if ( is_super_admin() && ! is_user_member_of_blog() ) {
                return;
+       }
 
        $settings = '';
        foreach ( $user_settings as $name => $value ) {
                $_name = preg_replace( '/[^A-Za-z0-9_]+/', '', $name );
                $_value = preg_replace( '/[^A-Za-z0-9_]+/', '', $value );
 
-               if ( ! empty( $_name ) )
+               if ( ! empty( $_name ) ) {
                        $settings .= $_name . '=' . $_value . '&';
+               }
        }
 
-       $settings = rtrim($settings, '&');
+       $settings = rtrim( $settings, '&' );
        parse_str( $settings, $_updated_user_settings );
 
        update_user_option( $user_id, 'user-settings', $settings, false );
@@ -894,11 +906,12 @@ function wp_set_all_user_settings( $user_settings ) {
  * @since 2.7.0
  */
 function delete_all_user_settings() {
-       if ( ! $user_id = get_current_user_id() )
+       if ( ! $user_id = get_current_user_id() ) {
                return;
+       }
 
        update_user_option( $user_id, 'user-settings', '', false );
-       setcookie('wp-settings-' . $user_id, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH);
+       setcookie( 'wp-settings-' . $user_id, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH );
 }
 
 /**
@@ -919,7 +932,7 @@ function get_site_option( $option, $default = false, $use_cache = true ) {
        /**
         * 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.
@@ -943,7 +956,7 @@ function get_site_option( $option, $default = false, $use_cache = true ) {
                /**
                 * 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
                 *
@@ -984,7 +997,7 @@ function get_site_option( $option, $default = false, $use_cache = true ) {
        /**
         * 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
@@ -1015,7 +1028,7 @@ function add_site_option( $option, $value ) {
        /**
         * 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
@@ -1060,7 +1073,7 @@ function add_site_option( $option, $value ) {
                /**
                 * 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
@@ -1103,7 +1116,7 @@ function delete_site_option( $option ) {
        /**
         * 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
         */
@@ -1126,7 +1139,7 @@ function delete_site_option( $option ) {
                /**
                 * 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
@@ -1170,7 +1183,7 @@ function update_site_option( $option, $value ) {
        /**
         * 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
@@ -1212,7 +1225,7 @@ function update_site_option( $option, $value ) {
                /**
                 * 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
@@ -1252,7 +1265,7 @@ function delete_site_transient( $transient ) {
        /**
         * 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
         *
@@ -1287,22 +1300,22 @@ function delete_site_transient( $transient ) {
 /**
  * Get the value of a site transient.
  *
- * If the transient does not exist or does not have a value, then the return value
- * will be false.
+ * If the transient does not exist, does not have a value, or has expired,
+ * then the return value will be false.
  *
  * @since 2.9.0
  *
  * @see get_transient()
  *
  * @param string $transient Transient name. Expected to not be SQL-escaped.
- * @return mixed Value of transient
+ * @return mixed Value of transient.
  */
 function get_site_transient( $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.
@@ -1341,7 +1354,7 @@ function get_site_transient( $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
         *
@@ -1360,9 +1373,10 @@ function get_site_transient( $transient ) {
  *
  * @see set_transient()
  *
- * @param string $transient Transient name. Expected to not be SQL-escaped.
- * @param mixed $value Transient value. Expected to not be SQL-escaped.
- * @param int $expiration Time until expiration in seconds, default 0
+ * @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.
  * @return bool False if value was not set and true if value was set.
  */
 function set_site_transient( $transient, $value, $expiration = 0 ) {
@@ -1370,7 +1384,7 @@ function set_site_transient( $transient, $value, $expiration = 0 ) {
        /**
         * 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
         *
@@ -1400,7 +1414,7 @@ function set_site_transient( $transient, $value, $expiration = 0 ) {
                /**
                 * 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
                 *