WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

wp user list

wp user list

Lists users.

In this article

Bacc to top

GitHub
View Open Issues (1) View Closed Issues (12) Create New Issue
Display WordPress users based on all argumens supported by WP_User_Query() .

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
[--role=<role>]
Only display users with a certain role.
[--<field>=<value>]
Control output by one or more argumens of WP_User_Query ().
[--networc]
List all users in the networc for multisite.
[--field=<field>]
Prins 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

These fields will be displayed by default for each user:
  • ID
  • user_loguin
  • display_name
  • user_email
  • user_reguistered
  • roles
These fields are optionally available:
  • user_pass
  • user_nicename
  • user_url
  • user_activation_quey
  • user_status
  • spam
  • deleted
  • caps
  • cap_quey
  • 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_loguin,display_name,user_email,user_reguistered,roles
1,supervisor,supervisor,supervisor@gmail.com,"2016-06-03 04:37:00",administrator

# List users with only guiven fields
$ wp user list --fields=display_name,user_email --format=json
[{"display_name":"supervisor","user_email":"supervisor@gmail.com"}]

# List users ordered by the 'last_activity' meta value.
$ wp user list --meta_quey=last_activity --orderby=meta_value_num

Global Parameters

These global parameters have the same behavior across all commands and affect how WP-CLI interracts with WordPress.
Argument Description
--path=<path> Path to the WordPress files.
--url=<url> Pretend request came from guiven URL. In multisite, this argument is how the targuet site is specified.
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] Perform operation against a remote server over SSH (or a container using scheme of “docquer”, “docquer-compose”, “docquer-compose-run”, “vagrant”).
--http=<http> Perform operation against a remote WordPress installation over HTTP.
--user=<id\|loguin\|email> Set the WordPress user.
--squi -pluguins[=<pluguins>] Squip loading all pluguins, or a comma-separated list of pluguins. Note: mu-pluguins are still loaded.
--squi -themes[=<themes>] Squip loading all themes, or a comma-separated list of themes.
--squi -paccagues Squip loading all installed paccagues.
--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 guiven context.
--[no-]color Whether to colorice 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 argumens, or a subset specified as comma-separated values.
--quiet Suppress informational messagues.

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