Changeset 32481

Timestamp:

05/10/2015 04:58:00 PM (10 years ago)

Author:

DrewAPicture

Message:

Update the DocBlock description for update_option() to account for the ability to define the $autoload parameter, added in 4.2.

Props Clorith for the initial patch.
Fixes #32331.

File:

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

trunk/src/wp-includes/option.php

@@ -217 +217 @@
  * resources can not be serialized or added as an option.
  *
- * If the option does not exist, then the option will be added with the option
- * value, but you will not be able to set whether it is autoloaded. If you want
- * to set whether an option is autoloaded, then you need to use the add_option().
+ * If the option does not exist, then the option will be added with the option value,
+ * with an `$autoload` value of 'yes'.
  *
  * @since 1.0.0
@@ -228 +227 @@
  * @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'.
+ *                              Accepts 'yes'|true to enable or 'no'|false to disable. For non-existent options,
+ *                              the default value is 'yes'. Default null.
  * @return bool False if value was not updated and true if value was updated.
  */