8.2.x user.module user_role_names($membersonly = FALSE, $permission = NULL)
8.0.x user.module user_role_names($membersonly = FALSE, $permission = NULL)
8.1.x user.module user_role_names($membersonly = FALSE, $permission = NULL)
8.3.x user.module user_role_names($membersonly = FALSE, $permission = NULL)

Retrieves the names of roles matching specified conditions.

Parameters

bool $membersonly: (optional) Set this to TRUE to exclude the 'anonymous' role. Defaults to FALSE.

string|null $permission: (optional) A string containing a permission. If set, only roles containing that permission are returned. Defaults to NULL, which returns all roles.

Return value

array An associative array with the role id as the key and the role name as value.

18 calls to user_role_names()
AccountForm::form in core/modules/user/src/AccountForm.php
Gets the actual form array to be built.
AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php
Form constructor.
BulkFormTest::testBulkForm in core/modules/user/src/Tests/Views/BulkFormTest.php
Tests the user bulk form.
ChangeUserRoleBase::buildConfigurationForm in core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php
FilterFormatAccessTest::testFormatRoles in core/modules/filter/src/Tests/FilterFormatAccessTest.php
Tests if text format is available to a role.

... See full list

File

core/modules/user/user.module, line 973
Enables the user registration and login system.

Code

function user_role_names($membersonly = FALSE, $permission = NULL) {
  return array_map(function($item) {
    return $item->label();
  }, user_roles($membersonly, $permission));
}