Changeset 30666

Timestamp:

11/30/2014 10:10:12 PM (10 years ago)

Author:

wonderboymusic

Message:

Improve the @param docs for src/wp-includes/user.php.

See #30224.

File:

• trunk/src/wp-includes/user.php (modified) (5 diffs)

trunk/src/wp-includes/user.php

@@ -20 +20 @@
  * @since 2.5.0
  *
- * @param array $credentials Optional. User info in order to sign on.
- * @param bool $secure_cookie Optional. Whether to use secure cookie.
+ * @param array       $credentials   Optional. User info in order to sign on.
+ * @param string|bool $secure_cookie Optional. Whether to use secure cookie.
  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
  */
@@ -230 +230 @@
  * @since 3.9.0
  *
- * @param int|bool $user The user ID (or false) as received from the
+ * @param int|bool $user_id The user ID (or false) as received from the
  *                       determine_current_user filter.
  * @return int|bool User ID if validated, false otherwise. If a user ID from
@@ -346 +346 @@
  * @param string $option     User option name.
  * @param int    $user       Optional. User ID.
- * @param bool   $deprecated Use get_option() to check for an option in the options table.
+ * @param string $deprecated Use get_option() to check for an option in the options table.
  * @return mixed User option value on success, false on failure.
  */
@@ -486 +486 @@
      * @since 3.1.0
      *
-     * @param string|array $args Optional. The query variables.
+     * @param null|string|array $args Optional. The query variables.
      * @return WP_User_Query
      */
@@ -2041 +2041 @@
  * @access private
  *
- * @param object $user WP_User instance.
+ * @param WP_User $user WP_User instance.
  * @return array
  */