Changeset 32613

Timestamp:

05/26/2015 10:16:15 PM (10 years ago)

Author:

wonderboymusic

Message:

Fix doc blocks for option.php.

See #32444.

File:

• trunk/src/wp-includes/option.php (modified) (15 diffs)

trunk/src/wp-includes/option.php

@@ -19 +19 @@
  * @since 1.5.0
  *
- * @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.
+ * @global wpdb $wpdb
+ *
+ * @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.
  * @return mixed Value set for the option.
  */
@@ -154 +156 @@
  * @since 2.2.0
  *
+ * @global wpdb $wpdb
+ *
  * @return array List of all options.
  */
@@ -185 +189 @@
  * @since 3.0.0
  *
+ * @global wpdb $wpdb
+ *
  * @param int $site_id Optional site ID for which to query the options. Defaults to the current site.
  */
@@ -222 +228 @@
  * @since 1.0.0
  * @since 4.2.0 The `$autoload` parameter was added.
+ *
+ * @global wpdb $wpdb
  *
  * @param string      $option   Option name. Expected to not be SQL-escaped.
@@ -363 +371 @@
  * @since 1.0.0
  *
+ * @global wpdb $wpdb
+ *
  * @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.
@@ -457 +467 @@
  *
  * @since 1.2.0
+ *
+ * @global wpdb $wpdb
  *
  * @param string $option Name of option to remove. Expected to not be SQL-escaped.
@@ -779 +791 @@
  * @since 2.7.0
  *
- * @param string $name The name of the setting.
+ * @param string $name    The name of the setting.
  * @param string $default Optional default value to return when $name is not set.
  * @return mixed the last saved user setting or the default value/false if it doesn't exist.
@@ -797 +809 @@
  * @since 2.8.0
  *
- * @param string $name The name of the setting.
+ * @param string $name  The name of the setting.
  * @param string $value The value for the setting.
- * @return null|bool true if set successfully/false if not.
+ * @return bool|void true if set successfully/false if not.
  */
 function set_user_setting( $name, $value ) {
-
     if ( headers_sent() ) {
         return false;
@@ -822 +833 @@
  *
  * @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.
+ * @return bool|void true if deleted successfully/false if not.
  */
 function delete_user_setting( $names ) {
-
     if ( headers_sent() ) {
         return false;
@@ -853 +863 @@
  * @since 2.7.0
  *
+ * @global array $_updated_user_settings
+ *
  * @return array the last saved user settings or empty array.
  */
@@ -891 +903 @@
  * @since 2.8.0
  *
+ * @global array $_updated_user_settings
+ *
  * @param array $user_settings
- * @return null|bool
+ * @return bool|void
  */
 function wp_set_all_user_settings( $user_settings ) {
@@ -945 +959 @@
  * @see get_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 $use_cache Whether to use cache. Multisite only. Default true.
+ * @global wpdb $wpdb
+ *
+ * @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.
  * @return mixed Value set for the option.
  */
@@ -1040 +1056 @@
  * @see add_option()
  *
+ * @global wpdb $wpdb
+ *
  * @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 mixed  $value  Optional. 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.
  */
@@ -1128 +1146 @@
  *
  * @see delete_option()
+ *
+ * @global wpdb $wpdb
  *
  * @param string $option Name of option to remove. Expected to not be SQL-escaped.
@@ -1193 +1213 @@
  * @see update_option()
  *
+ * @global wpdb $wpdb
+ *
  * @param string $option Name of 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 False if value was not updated and true if value was updated.
  */