wp user
Manages users, along with their roles, capabilities, and meta
Subcommands
| Name | Description |
|---|
add-cap | Adds a capability to a user |
add-role | Adds a role for a user |
check-password | Checks if a user’s password is valid or not |
create | Creates a new user |
delete | Deletes one or more users from the current site |
generate | Generates some users |
get | Gets details about a user |
import-csv | Imports users from a CSV file |
list | Lists users |
list-caps | Lists all capabilities for a user |
meta | Adds, updates, deletes, and lists user custom fields |
remove-cap | Removes a user’s capability |
remove-role | Removes a user’s role |
reset-password | Resets the password for one or more users |
session | Destroys and lists a user’s sessions |
set-role | Sets the user role |
spam | Marks one or more users as spam |
term | Adds, updates, removes, and lists user terms |
unspam | Removes one or more users from spam |
update | Updates an existing user |
Options
| Name | Description |
|---|
--path <path> | Path to the WordPress files |
--url <url> | Pretend request came from given URL. In multisite, this argument is how the target site is specified |
--ssh <options> | Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “vagrant”) |
--http <http> | Perform operation against a remote WordPress installation over HTTP |
--user <options> | Set the WordPress user |
--skip-plugins | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded |
--skip-plugins <plugins> | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded |
--skip-themes | Skip loading all themes, or a comma-separated list of themes |
--skip-themes <themes> | Skip loading all themes, or a comma-separated list of themes |
--skip-packages | Skip loading all installed packages |
--require <path> | Load PHP file before running the command (may be used more than once) |
--exec <php-code> | Execute PHP code before running the command (may be used more than once) |
--color | Whether to colorize the output |
--no-color | Whether to colorize the output |
--debug | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help |
--debug <group> | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help |
--prompt | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values |
--prompt <assoc> | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values |
--quiet | Suppress informational messages |