From bb365a5dc6ae6a6daa43b544548b98370b2b6e20 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Wed, 20 Apr 2016 15:44:05 +0000
Subject: [PATCH] Docs: Clarify parameter and return descriptions in the
 DocBlock for `wp_set_all_user_settings()`.

See [32613]. See #30989.


git-svn-id: https://develop.svn.wordpress.org/trunk@37263 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/option.php | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/wp-includes/option.php b/src/wp-includes/option.php
index a6f20913d0..72f6999184 100644
--- a/src/wp-includes/option.php
+++ b/src/wp-includes/option.php
@@ -941,11 +941,13 @@ function get_all_user_settings() {
  * Private. Set all user interface settings.
  *
  * @since 2.8.0
+ * @access private
  *
  * @global array $_updated_user_settings
  *
- * @param array $user_settings
- * @return bool|void
+ * @param array $user_settings User settings.
+ * @return bool|null False if the current user can't be found, null if the current
+ *                   user is not a super admin or a member of the site, otherwise true.
  */
 function wp_set_all_user_settings( $user_settings ) {
 	global $_updated_user_settings;