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

See [32613]. See #30989.

Built from https://develop.svn.wordpress.org/trunk@37264


git-svn-id: http://core.svn.wordpress.org/trunk@37230 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-04-20 15:47:26 +00:00
parent 14a399b69a
commit ddd3daf5ad
2 changed files with 5 additions and 3 deletions

View File

@ -844,13 +844,14 @@ function get_user_setting( $name, $default = false ) {
* Add or update user interface setting. * Add or update user interface setting.
* *
* Both $name and $value can contain only ASCII letters, numbers and underscores. * Both $name and $value can contain only ASCII letters, numbers and underscores.
*
* This function has to be used before any output has started as it calls setcookie(). * This function has to be used before any output has started as it calls setcookie().
* *
* @since 2.8.0 * @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. * @param string $value The value for the setting.
* @return bool|void true if set successfully/false if not. * @return bool|null True if set successfully, false if not. Null if the current user can't be established.
*/ */
function set_user_setting( $name, $value ) { function set_user_setting( $name, $value ) {
if ( headers_sent() ) { if ( headers_sent() ) {
@ -867,12 +868,13 @@ function set_user_setting( $name, $value ) {
* Delete user interface settings. * Delete user interface settings.
* *
* Deleting settings would reset them to the defaults. * Deleting settings would reset them to the defaults.
*
* This function has to be used before any output has started as it calls setcookie(). * This function has to be used before any output has started as it calls setcookie().
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param string $names The name or array of names of the setting to be deleted. * @param string $names The name or array of names of the setting to be deleted.
* @return bool|void true if deleted successfully/false if not. * @return bool|null True if deleted successfully, false if not. Null if the current user can't be established.
*/ */
function delete_user_setting( $names ) { function delete_user_setting( $names ) {
if ( headers_sent() ) { if ( headers_sent() ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.6-alpha-37263'; $wp_version = '4.6-alpha-37264';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.