Languages: English • Português do Brasil • Русский • insert user 日本語 (Add your language)
Insert /Update a user into the database. For updating an existing user and sending a password change email, use wp_update_user function instead.
<?php wp_insert_user( $userdata ); ?>
Below is an example showing how to insert a new user with the website profile field filled.
<?php
$website = "http://example.com";
$userdata = array(
'user_login' => 'login_name',
'user_url' => $website,
'user_pass' => NULL // When creating a new user, `user_pass` is expected.
);
$user_id = wp_insert_user( $userdata ) ;
//On success
if ( ! is_wp_error( $user_id ) ) {
echo "User created : ". $user_id;
}
?>
| Field Name | Description | Associated Filter |
|---|---|---|
| ID | An integer that will be used for updating an existing user. | (none) |
| user_pass | A string that contains the plain text password for the user. | pre_user_pass |
| user_login | A string that contains the user's username for logging in. | pre_user_login |
| user_nicename | A string that contains a URL-friendly name for the user. The default is the user's username. | pre_user_nicename |
| user_url | A string containing the user's URL for the user's web site. | pre_user_url |
| user_email | A string containing the user's email address. | pre_user_email |
| display_name | A string that will be shown on the site. Defaults to user's username. It is likely that you will want to change this, for both appearance and security through obscurity (that is if you dont use and delete the default admin user). | pre_user_display_name |
| nickname | The user's nickname, defaults to the user's username. | pre_user_nickname |
| first_name | The user's first name. | pre_user_first_name |
| last_name | The user's last name. | pre_user_last_name |
| description | A string containing content about the user. | pre_user_description |
| rich_editing | A string for whether to enable the rich editor or not. False if not empty. | (none) |
| user_registered | The date the user registered. Format is Y-m-d H:i:s. | (none) |
| role | A string used to set the user's role. | (none) |
| jabber | User's Jabber account. | (none) |
| aim | User's AOL IM account. | (none) |
| yim | User's Yahoo IM account. | (none) |
| locale | User's locale. | (none) |
If there is no ID, a new user will be created.
If you pass an ID , the user with that ID will be updated, and these meta fields are updated if set in $userdata otherwise they are set to null:
first_name, last_name, nickname, description, rich_editing, comment_shortcuts, admin_color, use_ssl, show_admin_bar_front, locale
When performing an update operation using wp_insert_user, user_pass should be the hashed password and not the plain text password.
As of 3.1 wp_insert_user() is located in wp-includes/user.php.
wp_update_user, wp_create_user
Blog User Functions: add_user_to_blog(), add_new_user_to_blog(), remove_user_from_blog(), is_user_member_of_blog()