Changeset 25204

Timestamp:

09/02/2013 03:24:33 AM (11 years ago)

Author:

SergeyBiryukov

Message:

Update phpdoc for get_user_to_edit(), get_userdata(), and get_user_by(). props tivnet. fixes #24992.

Location:

trunk/src

Files:

• wp-admin/includes/user.php (modified) (1 diff)
• wp-includes/pluggable.php (modified) (3 diffs)

trunk/src/wp-admin/includes/user.php

@@ -196 +196 @@
  *
  * @param int $user_id User ID.
- * @return object WP_User object with user data.
+ * @return WP_User|bool WP_User object on success, false on failure.
  */
 function get_user_to_edit( $user_id ) {
     $user = get_userdata( $user_id );
 
-    $user->filter = 'edit';
+    if ( $user )
+        $user->filter = 'edit';
 
     return $user;

trunk/src/wp-includes/pluggable.php

@@ -116 +116 @@
  *
  * @param int $user_id User ID
- * @return bool|object False on failure, WP_User object on success
+ * @return WP_User|bool WP_User object on success, false on failure.
  */
 function get_userdata( $user_id ) {
@@ -131 +131 @@
  * @param string $field The field to retrieve the user with. id | slug | email | login
  * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
- * @return bool|object False on failure, WP_User object on success
+ * @return WP_User|bool WP_User object on success, false on failure.
  */
 function get_user_by( $field, $value ) {
@@ -464 +464 @@
  * @param string $username User's username
  * @param string $password User's password
- * @return WP_Error|WP_User WP_User object if login successful, otherwise WP_Error object.
+ * @return WP_User|WP_Error WP_User object if login successful, otherwise WP_Error object.
  */
 function wp_authenticate($username, $password) {