function filter_get_roles_by_format

Retrieves a list of roles that are allowed to use a given text format.

Parameters

\Drupal\filter\FilterFormatInterface $format: An object representing the text format.

Return value

array An array of role names, keyed by role ID.

File

core/modules/filter/filter.module, line 83

Code

function filter_get_roles_by_format(FilterFormatInterface $format) : array {
  // Handle the fallback format upfront (all roles have access to this format).
  if ($format->isFallbackFormat()) {
    return array_map(fn(RoleInterface $role) => $role->label(), Role::loadMultiple());
  }
  // Do not list any roles if the permission does not exist.
  $permission = $format->getPermissionName();
  if (empty($permission)) {
    return [];
  }
  $roles = array_filter(Role::loadMultiple(), fn(RoleInterface $role) => $role->hasPermission($permission));
  return array_map(fn(RoleInterface $role) => $role->label(), $roles);
}