WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp user create

wp user create

Creates a new user.

In this article

View as Markdown

Back to top

GitHub
View Open Issues (0) View Closed Issues (29) Create New Issue
Note: The following options are not part of a stable WP-CLI release yet: --syntax_highlighting. To use them now, switch to the nightly build with wp cli update --nightly. If you installed the command as a separate package, updating that package may be enough.

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
<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. Possible values include ‘administrator’, ‘editor’, ‘author’, ‘contributor’, ‘subscriber’.
[–user_pass=<password>]
The user password. Default: randomly generated.
[–user_registered=<yyyy-mm-dd-hh-ii-ss>]
The date the user registered. Default: current date.
[–display_name=<name>]
The display name.
[–user_nicename=<nice_name>]
A string that contains a URL-friendly name for the user. The default is the user’s username.
[–user_url=<url>]
A string containing the user’s URL for the user’s web site.
[–nickname=<nickname>]
The user’s nickname, defaults to the user’s username.
[–first_name=<first_name>]
The user’s first name.
[–last_name=<last_name>]
The user’s last name.
[–description=<description>]
A string containing content about the user.
[–rich_editing=<rich_editing>]
Whether to enable the rich editor for the user. Accepts ‘true’ or ‘false’, or their numeric forms 1 and 0. Default: true
[–syntax_highlighting=<syntax_highlighting>]
Whether to enable the rich code editor for the user. Accepts ‘true’ or ‘false’, or their numeric forms 1 and 0. Default: true
[–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 bob@example.com --role=author
Success: Created user 3.
Password: k9**&amp;I4vNH(&amp;

# Create user without showing password upon success
$ wp user create ann ann@example.com --porcelain
4

Global Parameters

These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
Argument 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=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “docker-compose-run”, “vagrant”).
--ssh-args=<args> Pass additional arguments to SSH (or other tools specified by –ssh scheme).
--http=<http> Perform operation against a remote WordPress installation over HTTP.
--user=<id\|login\|email> Set the WordPress user.
--skip-plugins[=<plugins>] Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded.
--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).
--context=<context> Load WordPress in a given context.
--[no-]color Whether to colorize the output.
--debug[=<group>] Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.
--prompt[=<assoc>] Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.
--quiet Suppress informational messages.
--alias=<name> Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file.
--assume-https Set $_SERVER[‘HTTPS’] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer.

Command documentation is regenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.