function user_role_names in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/user/user.module \user_role_names()
2. 10 core/modules/user/user.module \user_role_names()

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.

17 calls to user_role_names()

AccountForm::form in core/modules/user/src/AccountForm.php

Gets the actual form array to be built.

BulkFormTest::testBulkForm in core/modules/user/tests/src/Functional/Views/BulkFormTest.php

Tests the user bulk form.

ChangeUserRoleBase::buildConfigurationForm in core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php

Form constructor.

FilterFormatAccessTest::testFormatRoles in core/modules/filter/tests/src/Functional/FilterFormatAccessTest.php

Tests if text format is available to a role.

FilterFormatFormBase::form in core/modules/filter/src/FilterFormatFormBase.php

Gets the actual form array to be built.

... See full list

File

core/modules/user/user.module, line 835

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));
}