WordPress.org

Function Reference/wp update user

Languages: English • 한국어 • (Add your language)

Description

Update 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.

Note: Use the wp_insert_user function to create a new user.

Usage

<?php wp_update_user( $userdata ) ?>

Parameters

$userdata

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

Default: None

Return Values

UserID (integer): The updated user's ID.

Examples

Below is an example showing how to update a user's Website profile field

<?php
require_once( ABSPATH . WPINC . '/registration.php');
$user_id = 1;
$website = 'http://wordpress.org';
wp_update_user( array ('ID' => $user_id, 'user_url' => $website) ) ;
?>

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/user.php.

WordPress.org

Codex

Function Reference/wp update user

Contents