add_role() — описание функции WordPress на русском

Сигнатура

add_role( string $role, string $display_name, array|array $capabilities = array() ): WP_Role|void

Описание

Список прав доступа можно передать либо как числоиндексированный массив имён прав, либо как ассоциативный массив логических значений с ключами по имени права. Чтобы явно запретить роли право доступа, установите значение этого права в false.
Примеры:
// Add a role that can edit posts.
add_role( 'custom_role', 'Custom Role', array(
'read',
'edit_posts',
) );Или с использованием ассоциативного массива:
// Add a role that can edit posts but explicitly cannot not delete them.
add_role( 'custom_role', 'Custom Role', array(
'read' => true,
'edit_posts' => true,
'delete_posts' => false,
) );

Оригинал (английский)

The list of capabilities can be passed either as a numerically indexed array of capability names, or an associative array of boolean values keyed by the capability name. To explicitly deny the role a capability, set the value for that capability to false.

Examples:

// Add a role that can edit posts.
add_role( 'custom_role', 'Custom Role', array(
    'read',
    'edit_posts',
) );

Or, using an associative array:

// Add a role that can edit posts but explicitly cannot not delete them.
add_role( 'custom_role', 'Custom Role', array(
    'read' => true,
    'edit_posts' => true,
    'delete_posts' => false,
) );

Параметры

$role string обязательный

Имя роли.

$display_name string обязательный

Отображаемое имя роли.

$capabilities <span class="array”>array необязательный = array()

Права доступа, добавляемые к роли.

Возвращаемое значение

WP_Role|void

WP_Role

Исходный код

wp-includes/capabilities.php:1135

function add_role( $role, $display_name, $capabilities = array() ) {
	if ( empty( $role ) ) {
		return;
	}

	return wp_roles()->add_role( $role, $display_name, $capabilities );
}

История изменений

Версия	Описание
6.9.0	Support was added for a numerically indexed array of strings for the capabilities array.
2.0.0	Introduced.