Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. AccountInterface.php

function AccountInterface::getRoles

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.

3 methods override AccountInterface::getRoles()
AccountProxy::getRoles in core/lib/Drupal/Core/Session/AccountProxy.php
Returns a list of roles.
User::getRoles in core/modules/user/src/Entity/User.php
Returns a list of roles.
UserSession::getRoles in core/lib/Drupal/Core/Session/UserSession.php
Returns a list of roles.

File

core/lib/Drupal/Core/Session/AccountInterface.php, line 42

Class

AccountInterface
Defines an account interface which represents the current user.

Namespace

Drupal\Core\Session

Code

public function getRoles($exclude_locked_roles = FALSE);

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal