function AccountInterface::getRoles
Same name in other branches
- 9 core/lib/Drupal/Core/Session/AccountInterface.php \Drupal\Core\Session\AccountInterface::getRoles()
- 8.9.x core/lib/Drupal/Core/Session/AccountInterface.php \Drupal\Core\Session\AccountInterface::getRoles()
- 10 core/lib/Drupal/Core/Session/AccountInterface.php \Drupal\Core\Session\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\SessionCode
public function getRoles($exclude_locked_roles = FALSE);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.