WordPress 4.1

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

diff --git a/wp-includes/option.php b/wp-includes/option.php
index c6417dbeade3867278f746c8f6e5b29c62909ae3..6134606471347db74f641f73250885c9de53caa3 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.
         *
-        * 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
         *
@@ -564,7 +562,7 @@ 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
         *
@@ -632,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
         *
@@ -679,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
                 *
@@ -777,7 +775,7 @@ 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 ) {
 
@@ -799,8 +797,8 @@ 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 ) {
 
@@ -870,7 +868,7 @@ 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;
@@ -934,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.
@@ -958,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
                 *
@@ -999,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
@@ -1030,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
@@ -1075,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
@@ -1118,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
         */
@@ -1141,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
@@ -1185,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
@@ -1227,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
@@ -1267,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
         *
@@ -1317,7 +1315,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.
         *
         * Passing a truthy value to the filter will effectively short-circuit retrieval,
         * returning the passed value instead.
@@ -1356,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
         *
@@ -1386,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
         *
@@ -1416,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
                 *