WordPress.org

Make WordPress Core

Changeset 37264


Ignore:
Timestamp:
04/20/2016 03:46:53 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Clarify return descriptions in the DocBlocks for set_user_setting() and delete_user_setting().

See [32613]. See #30989.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/option.php

    r37263 r37264  
    845845 *
    846846 * Both $name and $value can contain only ASCII letters, numbers and underscores.
     847 *
    847848 * This function has to be used before any output has started as it calls setcookie().
    848849 *
     
    851852 * @param string $name  The name of the setting.
    852853 * @param string $value The value for the setting.
    853  * @return bool|void true if set successfully/false if not.
     854 * @return bool|null True if set successfully, false if not. Null if the current user can't be established.
    854855 */
    855856function set_user_setting( $name, $value ) {
     
    868869 *
    869870 * Deleting settings would reset them to the defaults.
     871 *
    870872 * This function has to be used before any output has started as it calls setcookie().
    871873 *
     
    873875 *
    874876 * @param string $names The name or array of names of the setting to be deleted.
    875  * @return bool|void true if deleted successfully/false if not.
     877 * @return bool|null True if deleted successfully, false if not. Null if the current user can't be established.
    876878 */
    877879function delete_user_setting( $names ) {
Note: See TracChangeset for help on using the changeset viewer.