WordPress.org

Function Reference/wp update user

Contents 1 Description 2 Usage 3 Parameters 4 Return Values 5 Examples 6 Notes 7 Change Log 8 Source File 9 Related

Description

Update (or create) a user in the database.

It is possible to update a user's password by specifying the 'user_pass' value in the $userdata parameter array.

If $userdata does not contain an 'ID' key, then a new user will be created and the new user's ID will be returned.

If current user's password is being updated, then the cookies will be cleared.

Usage

<?php wp_update_user( $userdata ) ?>

Parameters

$userdata

(array) (required) An array of user data.

Default: None

Return Values

(integer) 

The updated user's ID.

Examples

Notes

• Uses: get_userdata()
• Uses: wp_hash_password()
• Uses: wp_insert_user() Used to update existing user or add new one if user doesn't exist already
• Uses: wp_get_current_user()
• Uses: wp_clear_auth_cookie()
• Uses: wp_set_auth_cookie()

Change Log

Since: 2.0.0

Source File

wp_update_user() is located in wp-includes/registration.php.

Related

• Home Page
• WordPress Lessons
• Getting Started
• Working with WordPress
• Design and Layout
• Advanced Topics
• Troubleshooting
• Developer Docs
• About WordPress

Codex Resources

• Community portal
• Current events
• Recent changes
• Random page
• Help