Changeset 37263 for trunk/src/wp-includes/option.php

Timestamp:

04/20/2016 03:44:05 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Clarify parameter and return descriptions in the DocBlock for wp_set_all_user_settings().

See [32613]. See #30989.

File:

• trunk/src/wp-includes/option.php (modified) (1 diff)

trunk/src/wp-includes/option.php

@@ -942 +942 @@
  *
  * @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 ) {