Remove docs suggesting that wp_insert_user() can be used to update an existing user. wp_update_user() should be used instead. fixes #25745.
git-svn-id: https://develop.svn.wordpress.org/trunk@25978 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
78f8c980da
commit
e3e3e1d109
|
@ -1258,12 +1258,6 @@ function validate_username( $username ) {
|
||||||
/**
|
/**
|
||||||
* Insert an user into the database.
|
* Insert an user into the database.
|
||||||
*
|
*
|
||||||
* Can update a current user or insert a new user based on whether the user's ID
|
|
||||||
* is present.
|
|
||||||
*
|
|
||||||
* Can be used to update the user's info (see below), set the user's role, and
|
|
||||||
* set the user's preference on whether they want the rich editor on.
|
|
||||||
*
|
|
||||||
* Most of the $userdata array fields have filters associated with the values.
|
* Most of the $userdata array fields have filters associated with the values.
|
||||||
* The exceptions are 'rich_editing', 'role', 'jabber', 'aim', 'yim',
|
* The exceptions are 'rich_editing', 'role', 'jabber', 'aim', 'yim',
|
||||||
* 'user_registered', and 'ID'. The filters have the prefix 'pre_user_' followed
|
* 'user_registered', and 'ID'. The filters have the prefix 'pre_user_' followed
|
||||||
|
@ -1456,7 +1450,6 @@ function wp_insert_user( $userdata ) {
|
||||||
*
|
*
|
||||||
* @since 2.0.0
|
* @since 2.0.0
|
||||||
* @see wp_insert_user() For what fields can be set in $userdata
|
* @see wp_insert_user() For what fields can be set in $userdata
|
||||||
* @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|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
|
* @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
|
||||||
|
|
Loading…
Reference in New Issue