Login Register

AccountInterface::getRoles

public AccountInterface::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.

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

1	`public` `function` `getRoles($exclude_locked_roles` `= FALSE);`

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Session%21AccountInterface.php/function/AccountInterface%3A%3AgetRoles/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments

Leave a Comment

Please login to continue.

Popular Articles

AccountInterface::isAuthenticated public AccountInterface::isAuthenticated() Returns TRUE if the account is authenticated. Return value bool TRUE if the account is authenticated. Fil

AccountInterface::isAnonymous public AccountInterface::isAnonymous() Returns TRUE if the account is anonymous. Return value bool TRUE if the account is anonymous. File core/lib/D

TokenInterface::getRoles() RoleInterface[] getRoles() Returns the user roles. Return Value RoleInterface[] An array of RoleInterface instances

UserInterface::getRoles() (Role|string)[] getRoles() Returns the roles granted to the user. public function getRoles() { return array('ROLE_USER'); } Alte

AccountInterface Defines an account interface which represents the current user. Defines an object that has a user id, roles and can have session data. The interface