wp user
Manages users, along with their roles, capabilities, and meta.
See references for Roles and Capabilities and WP User class.
Subcommands
| Command | Description |
|---|---|
wp user add-cap |
Adds a capability to a user. |
wp user add-role |
Adds a role for a user. |
wp user application-password |
Creates, updates, deletes, lists and retrieves application passwords. |
wp user check-password |
Checks if a user’s password is valid or not. |
wp user create |
Creates a new user. |
wp user delete |
Deletes one or more users from the current site. |
wp user exists |
Verifies whether a user exists. |
wp user generate |
Generates some users. |
wp user get |
Gets details about a user. |
wp user import-csv |
Imports users from a CSV file. |
wp user list |
Lists users. |
wp user list-caps |
Lists all capabilities for a user. |
wp user meta |
Adds, updates, deletes, and lists user custom fields. |
wp user remove-cap |
Removes a user’s capability. |
wp user remove-role |
Removes a user’s role. |
wp user reset-password |
Resets the password for one or more users. |
wp user session |
Destroys and lists a user’s sessions. |
wp user set-role |
Sets the user role. |
wp user signup |
Manages signups on a multisite installation. |
wp user spam |
Marks one or more users as spam on multisite. |
wp user term |
Adds, updates, removes, and lists user terms. |
wp user unspam |
Removes one or more users from spam on multisite. |
wp user update |
Updates an existing user. |
wp user create
Creates a new user.
Synopsis
wp user create <user-login> <user-email> [--role=<role>] [--user_pass=<password>] [--user_registered=<yyyy-mm-dd-hh-ii-ss>] [--display_name=<name>] [--user_nicename=<nice_name>] [--user_url=<url>] [--nickname=<nickname>] [--first_name=<first_name>] [--last_name=<last_name>] [--description=<description>] [--rich_editing=<rich_editing>] [--send-email] [--porcelain]
Options
<user-login>
: The login of the user to create.
<user-email>
: The email address of the user to create.
[--role=<role>]
: The role of the user to create. Default: default role. Options: administrator, editor, author, contributor, subscriber.
[--user_pass=<password>]
: The user password. Default: randomly generated.
[--send-email]
: Send an email to the user with their new account details.
[--porcelain]
: Output just the new user id.
Examples
# Create user
$ wp user create bob [email protected] --role=author
Success: Created user 3.
Password: k9**&I4vNH(&
# Create user without showing password upon success
$ wp user create ann [email protected] --porcelain
4
wp user delete
Deletes one or more users from the current site.
Synopsis
wp user delete <user>... [--network] [--reassign=<user-id>] [--yes]
Options
<user>...
: The user login, user email, or user ID of the user(s) to delete.
[--network]
: On multisite, delete the user from the entire network.
[--reassign=<user-id>]
: User ID to reassign the posts to.
[--yes]
: Answer yes to any confirmation prompts.
Examples
# Delete user 123 and reassign posts to user 567
$ wp user delete 123 --reassign=567
Success: Removed user 123 from http://example.com.
# Delete all contributors and reassign their posts to user 2
$ wp user delete $(wp user list --role=contributor --field=ID) --reassign=2
Success: Removed user 813 from http://example.com.
Success: Removed user 578 from http://example.com.
wp user list
Lists users.
Synopsis
wp user list [--role=<role>] [--<field>=<value>] [--network] [--field=<field>] [--fields=<fields>] [--format=<format>]
Options
[--role=<role>]
: Only display users with a certain role.
[--<field>=<value>]
: Control output by one or more arguments of WP_User_Query().
[--network]
: List all users in the network for multisite.
[--field=<field>]
: Prints the value of a single field for each user.
[--fields=<fields>]
: Limit the output to specific object fields.
[--format=<format>]
: Render output in a particular format. Default: table. Options: table, csv, ids, json, count, yaml.
Available Fields
Default fields: ID, user_login, display_name, user_email, user_registered, roles.
Optional fields: user_pass, user_nicename, user_url, user_activation_key, user_status, spam, deleted, caps, cap_key, allcaps, filter, url.
Examples
# List user IDs
$ wp user list --field=ID
1
# List users with administrator role
$ wp user list --role=administrator --format=csv
ID,user_login,display_name,user_email,user_registered,roles
1,supervisor,supervisor,[email protected],"2016-06-03 04:37:00",administrator
# List users with only given fields
$ wp user list --fields=display_name,user_email --format=json
[{"display_name":"supervisor","user_email":"[email protected]"}]
wp user update
Updates an existing user.
Synopsis
wp user update <user>... [--user_pass=<password>] [--user_nicename=<nice_name>] [--user_url=<url>] [--user_email=<email>] [--display_name=<display_name>] [--nickname=<nickname>] [--first_name=<first_name>] [--last_name=<last_name>] [--description=<description>] [--rich_editing=<rich_editing>] [--user_registered=<yyyy-mm-dd-hh-ii-ss>] [--role=<role>] [--skip-email]
Examples
# Update user
$ wp user update 123 --display_name=Mary --user_pass=marypass
Success: Updated user 123.
Examples
# List user IDs
$ wp user list --field=ID
1
# Create a new user.
$ wp user create bob [email protected] --role=author
Success: Created user 3.
Password: k9**&I4vNH(&
# Update an existing user.
$ wp user update 123 --display_name=Mary --user_pass=marypass
Success: Updated user 123.
# Delete user 123 and reassign posts to user 567
$ wp user delete 123 --reassign=567
Success: Removed user 123 from http://example.com.