wp user

Manages users, along with their roles, capabilities, and meta

Subcommands

NameDescription
add-capAdds a capability to a user
add-roleAdds a role for a user
check-passwordChecks if a user’s password is valid or not
createCreates a new user
deleteDeletes one or more users from the current site
generateGenerates some users
getGets details about a user
import-csvImports users from a CSV file
listLists users
list-capsLists all capabilities for a user
metaAdds, updates, deletes, and lists user custom fields
remove-capRemoves a user’s capability
remove-roleRemoves a user’s role
reset-passwordResets the password for one or more users
sessionDestroys and lists a user’s sessions
set-roleSets the user role
spamMarks one or more users as spam
termAdds, updates, removes, and lists user terms
unspamRemoves one or more users from spam
updateUpdates an existing user

Options

NameDescription
--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-pluginsSkip 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-themesSkip 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-packagesSkip 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)
--colorWhether to colorize the output
--no-colorWhether to colorize the output
--debugShow 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
--promptPrompt 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
--quietSuppress informational messages