UserSession::getRoles

public UserSession::getRoles($exclude_locked_roles = FALSE)

Returns a list of roles.

Parameters

bool $exclude_locked_roles: (optional) If TRUE, locked roles (anonymous/authenticated) are not returned.

Return value

array List of role IDs.

Overrides AccountInterface::getRoles

File

core/lib/Drupal/Core/Session/UserSession.php, line 92

Class

UserSession

An implementation of the user account interface for the global user.

Namespace

Drupal\Core\Session

Code

public function getRoles($exclude_locked_roles = FALSE) {
  $roles = $this->roles;

  if ($exclude_locked_roles) {
    $roles = array_values(array_diff($roles, array(AccountInterface::ANONYMOUS_ROLE, AccountInterface::AUTHENTICATED_ROLE)));
  }

  return $roles;
}