Wp user (WP-CLI)

wp user: Manages users, along with their roles, capabilities, and meta.

$wp help user

NAME

  wp user

DESCRIPTION

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

SYNOPSIS

  wp user <command>

SUBCOMMANDS

  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.

  See references for [Roles and Capabilities][1] and [WP User class][2].

  ---
  [1] https://codex.wordpress.org/Roles_and_Capabilities
  [2] https://codex.wordpress.org/Class_Reference/WP_User

EXAMPLES

    # List user IDs
    $ wp user list --field=ID
    1

    # Create a new user.
    $ wp user create bob bob@example.com --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

wp user list

$ wp help user list

NAME

  wp user list

DESCRIPTION

  Lists users.

SYNOPSIS

  wp user list [--role=<role>] [--<field>=<value>] [--network] [--field=<field>] [--fields=<fields>]
  [--format=<format>]

  Display WordPress users based on all arguments supported by
  [WP_User_Query()][1].

  ---
  [1] https://developer.wordpress.org/reference/classes/wp_user_query/prepare_query/

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

  These fields will be displayed by default for each user:

  * ID
  * user_login
  * display_name
  * user_email
  * user_registered
  * roles

  These fields are optionally available:

  * 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,supervisor@gmail.com,"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":"supervisor@gmail.com"}]

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