Update wp_update_user() phpdoc to reflect a possible return of WP_Error. Props SergeyBiryukov. fixes #21439

git-svn-id: http://core.svn.wordpress.org/trunk@21509 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Ryan Boren 2012-08-14 19:29:40 +00:00
parent 77fdb14c2c
commit 17f544b798
1 changed files with 1 additions and 1 deletions

View File

@ -1393,7 +1393,7 @@ function wp_insert_user( $userdata ) {
* @uses wp_insert_user() Used to update existing user or add new one if user doesn't exist already * @uses wp_insert_user() Used to update existing user or add new one if user doesn't exist already
* *
* @param mixed $userdata An array of user data or a user object of type stdClass or WP_User. * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
* @return int The updated user's ID. * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
*/ */
function wp_update_user($userdata) { function wp_update_user($userdata) {
if ( is_a( $userdata, 'stdClass' ) ) if ( is_a( $userdata, 'stdClass' ) )