wp role

Управляет ролями пользователей. Есть сброс настроек по умолчанию.

Список команд	Описание
wp role list	Список всех ролей.
wp role exists	Проверяет, существует ли роль.
wp role create	Создает новую роль.
wp role delete	Удаляет существующую роль.
wp role reset	Сбрасывает права базовых ролей на права по умолчанию.

Примеры

# List roles.
$ wp role list --fields=role --format=csv
role
administrator
editor
author
contributor
subscriber

# Check to see if a role exists.
$ wp role exists editor
Success: Role with ID 'editor' exists.

# Create a new role.
$ wp role create approver Approver
Success: Role with key 'approver' created.

# Delete an existing role.
$ wp role delete approver
Success: Role with key 'approver' deleted.

# Reset existing roles to their default capabilities.
$ wp role reset administrator author contributor
Success: Reset 3/3 roles.

Исходный код команд

• wp-cli/role-command
  • Role_Command.php

---

wp role list

Список всех ролей.

wp role list [--fields=<fields>] [--format=<format>]

Использование

wp role list [--fields={fields}] [--field={field}] [--format={format}]

Можно указать Глобальные параметры и следующие:

[--fields={fields}]

Limit the output to specific object fields.

[--field={field}]

Prints the value of a single field.

[--format={format}]

Render output in a particular format.
По умолчанию: table
Может быть:

• table
• csv
• json
• count
• yaml

Доступные поля

These fields will be displayed by default for each role:

• name
• role

There are no optional fields.

Примеры

# List roles.
$ wp role list --fields=role --format=csv
role
administrator
editor
author
contributor
subscriber

wp role exists

Проверяет, существует ли роль.

wp role exists <role-key>

Exits with return code 0 if the role exists, 1 if it does not.

Использование

wp role exists {role-key}

Можно указать Глобальные параметры и следующие:

{role-key}

The internal name of the role.

Примеры

# Check if a role exists.
$ wp role exists editor
Success: Role with ID 'editor' exists.

wp role create

Создает новую роль.

wp role create <role-key> <role-name> [--clone=<role>]

Использование

wp role create {role-key} {role-name} [--clone={role}]

Можно указать Глобальные параметры и следующие:

{role-key}

The internal name of the role.

{role-name}

The publicly visible name of the role.

[--clone={role}]

Clone capabilities from an existing role.

Примеры

# Create role for Approver.
$ wp role create approver Approver
Success: Role with key 'approver' created.

# Create role for Product Administrator.
$ wp role create productadmin "Product Administrator"
Success: Role with key 'productadmin' created.

wp role delete

Удаляет существующую роль.

wp role delete <role-key>

Использование

wp role delete {role-key}

Можно указать Глобальные параметры и следующие:

{role-key}

The internal name of the role.

Примеры

# Delete approver role.
$ wp role delete approver
Success: Role with key 'approver' deleted.

# Delete productadmin role.
wp role delete productadmin
Success: Role with key 'productadmin' deleted.

wp role reset

Сбрасывает права базовых ролей на права по умолчанию.

wp role reset [<role-key>...] [--all]

Использование

wp role reset [{role-key}...] [--all]

Можно указать Глобальные параметры и следующие:

[{role-key}...]

The internal name of one or more roles to reset.

[--all]

If set, all default roles will be reset.

Примеры

# Reset role.
$ wp role reset administrator author contributor
Success: Reset 1/3 roles.

# Reset all default roles.
$ wp role reset --all
Success: All default roles reset.