1. 8.5.x core/modules/user/src/Plugin/migrate/source/d7/Role.php Role
  2. 8.5.x core/modules/user/src/Entity/Role.php Role
  3. 8.5.x core/modules/user/src/Plugin/views/access/Role.php Role
  4. 8.5.x core/modules/user/src/Plugin/migrate/source/d6/Role.php Role
  5. 8.0.x core/modules/user/src/Plugin/migrate/source/d7/Role.php Role
  6. 8.0.x core/modules/user/src/Entity/Role.php Role
  7. 8.0.x core/modules/user/src/Plugin/views/access/Role.php Role
  8. 8.0.x core/modules/user/src/Plugin/migrate/source/d6/Role.php Role
  9. 8.1.x core/modules/user/src/Plugin/migrate/source/d7/Role.php Role
  10. 8.1.x core/modules/user/src/Plugin/migrate/source/d6/Role.php Role
  11. 8.1.x core/modules/user/src/Plugin/views/access/Role.php Role
  12. 8.1.x core/modules/user/src/Entity/Role.php Role
  13. 8.2.x core/modules/user/src/Plugin/migrate/source/d7/Role.php Role
  14. 8.2.x core/modules/user/src/Entity/Role.php Role
  15. 8.2.x core/modules/user/src/Plugin/views/access/Role.php Role
  16. 8.2.x core/modules/user/src/Plugin/migrate/source/d6/Role.php Role
  17. 8.3.x core/modules/user/src/Plugin/views/access/Role.php Role
  18. 8.3.x core/modules/user/src/Entity/Role.php Role
  19. 8.3.x core/modules/user/src/Plugin/migrate/source/d7/Role.php Role
  20. 8.3.x core/modules/user/src/Plugin/migrate/source/d6/Role.php Role
  21. 8.4.x core/modules/user/src/Entity/Role.php Role
  22. 8.4.x core/modules/user/src/Plugin/views/access/Role.php Role
  23. 8.4.x core/modules/user/src/Plugin/migrate/source/d6/Role.php Role
  24. 8.4.x core/modules/user/src/Plugin/migrate/source/d7/Role.php Role
  25. 8.6.x core/modules/user/src/Plugin/migrate/source/d7/Role.php Role
  26. 8.6.x core/modules/user/src/Plugin/migrate/source/d6/Role.php Role
  27. 8.6.x core/modules/user/src/Plugin/views/access/Role.php Role
  28. 8.6.x core/modules/user/src/Entity/Role.php Role

Defines the user role entity class.

Plugin annotation

  id = "user_role",
  label = @Translation("Role"),
  handlers = {
    "storage" = "Drupal\user\RoleStorage",
    "access" = "Drupal\user\RoleAccessControlHandler",
    "list_builder" = "Drupal\user\RoleListBuilder",
    "form" = {
      "default" = "Drupal\user\RoleForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm"
  admin_permission = "administer permissions",
  config_prefix = "role",
  static_cache = TRUE,
  entity_keys = {
    "id" = "id",
    "weight" = "weight",
    "label" = "label"
  links = {
    "delete-form" = "/admin/people/roles/manage/{user_role}/delete",
    "edit-form" = "/admin/people/roles/manage/{user_role}",
    "edit-permissions-form" = "/admin/people/permissions/{user_role}",
    "collection" = "/admin/people/roles",
  config_export = {


Expanded class hierarchy of Role

60 files declare their use of Role
BlockTest.php in core/modules/block/tests/src/Functional/BlockTest.php
CacheContextOptimizationTest.php in core/tests/Drupal/KernelTests/Core/Cache/CacheContextOptimizationTest.php
CommentAdminViewTest.php in core/modules/comment/tests/src/Kernel/Views/CommentAdminViewTest.php
CommentCacheTagsTest.php in core/modules/comment/src/Tests/CommentCacheTagsTest.php
CommentFieldAccessTest.php in core/modules/comment/tests/src/Kernel/CommentFieldAccessTest.php

... See full list

10 string references to 'Role'
ChangeUserRoleBase::buildConfigurationForm in core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php
Form constructor.
filter.schema.yml in core/modules/filter/config/schema/filter.schema.yml
Role::buildOptionsForm in core/modules/user/src/Plugin/views/access/Role.php
Provide a form to edit options for this plugin.
SimpleTestTest::confirmStubTestResults in core/modules/simpletest/src/Tests/SimpleTestTest.php
Confirm that the stub test produced the desired results.
user.schema.yml in core/modules/user/config/schema/user.schema.yml

... See full list


core/modules/user/src/Entity/Role.php, line 47


View source
class Role extends ConfigEntityBase implements RoleInterface {

   * The machine name of this role.
   * @var string
  protected $id;

   * The human-readable label of this role.
   * @var string
  protected $label;

   * The weight of this role in administrative listings.
   * @var int
  protected $weight;

   * The permissions belonging to this role.
   * @var array
  protected $permissions = [];

   * An indicator whether the role has all permissions.
   * @var bool
  protected $is_admin;

   * {@inheritdoc}
  public function getPermissions() {
    if ($this
      ->isAdmin()) {
      return [];
    return $this->permissions;

   * {@inheritdoc}
  public function getWeight() {
    return $this

   * {@inheritdoc}
  public function setWeight($weight) {
      ->set('weight', $weight);
    return $this;

   * {@inheritdoc}
  public function hasPermission($permission) {
    if ($this
      ->isAdmin()) {
      return TRUE;
    return in_array($permission, $this->permissions);

   * {@inheritdoc}
  public function grantPermission($permission) {
    if ($this
      ->isAdmin()) {
      return $this;
    if (!$this
      ->hasPermission($permission)) {
      $this->permissions[] = $permission;
    return $this;

   * {@inheritdoc}
  public function revokePermission($permission) {
    if ($this
      ->isAdmin()) {
      return $this;
    $this->permissions = array_diff($this->permissions, [
    return $this;

   * {@inheritdoc}
  public function isAdmin() {
    return (bool) $this->is_admin;

   * {@inheritdoc}
  public function setIsAdmin($is_admin) {
    $this->is_admin = $is_admin;
    return $this;

   * {@inheritdoc}
  public static function postLoad(EntityStorageInterface $storage, array &$entities) {
    parent::postLoad($storage, $entities);

    // Sort the queried roles by their weight.
    // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
    uasort($entities, 'static::sort');

   * {@inheritdoc}
  public function preSave(EntityStorageInterface $storage) {
    if (!isset($this->weight) && ($roles = $storage
      ->loadMultiple())) {

      // Set a role weight to make this new role last.
      $max = array_reduce($roles, function ($max, $role) {
        return $max > $role->weight ? $max : $role->weight;
      $this->weight = $max + 1;
    if (!$this
      ->isSyncing()) {

      // Permissions are always ordered alphabetically to avoid conflicts in the
      // exported configuration.



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
ConfigEntityBase::$isSyncing private property Whether the config is being created, updated or deleted through the import process.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity.
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides Entity::createDuplicate
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides Entity::getCacheTagsToInvalidate
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides Entity::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides Entity::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides Entity::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides Entity::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides Entity::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::isSyncing public function Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface::isSyncing
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides Entity::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides Entity::preDelete
ConfigEntityBase::save public function Saves an entity permanently. Overrides Entity::save
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides Entity::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setSyncing public function Sets the status of the isSyncing flag. Overrides ConfigEntityInterface::setSyncing
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label.
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides Entity::toArray
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides Entity::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides Entity::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides Entity::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides Entity::__construct
ConfigEntityBase::__sleep public function Overrides Entity::__sleep
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties. Overrides KernelTestBase::__sleep Aliased as: traitSleep
DependencySerializationTrait::__wakeup public function
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
Entity::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId protected property The entity type.
Entity::$typedData protected property A typed data object wrapping this entity.
Entity::access public function Checks data value access. Overrides AccessibleInterface::access
Entity::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle
Entity::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
Entity::delete public function Deletes an entity permanently. Overrides EntityInterface::delete
Entity::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated protected function Gets the entity manager.
Entity::entityTypeManager protected function Gets the entity type manager.
Entity::getCacheContexts public function The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags public function The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::id public function Gets the identifier. Overrides EntityInterface::id
Entity::label public function Gets the label of the entity. Overrides EntityInterface::label
Entity::language public function Gets the language of the entity. Overrides EntityInterface::language
Entity::languageManager protected function Gets the language manager.
Entity::linkTemplates protected function Gets an array link templates.
Entity::load public static function Loads an entity. Overrides EntityInterface::load
Entity::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
Entity::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate
Entity::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete
Entity::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave
Entity::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
Entity::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
Entity::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::urlRouteParameters protected function Gets an array of placeholders for this entity.
Entity::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
Entity::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance.
RefinableCacheableDependencyTrait::$cacheContexts protected property Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags protected property Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
RefinableCacheableDependencyTrait::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
RefinableCacheableDependencyTrait::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge
Role::$id protected property The machine name of this role.
Role::$is_admin protected property An indicator whether the role has all permissions.
Role::$label protected property The human-readable label of this role.
Role::$permissions protected property The permissions belonging to this role.
Role::$weight protected property The weight of this role in administrative listings.
Role::getPermissions public function Returns a list of permissions assigned to the role. Overrides RoleInterface::getPermissions
Role::getWeight public function Returns the weight. Overrides RoleInterface::getWeight
Role::grantPermission public function Grant permissions to the role. Overrides RoleInterface::grantPermission
Role::hasPermission public function Checks if the role has a permission. Overrides RoleInterface::hasPermission
Role::isAdmin public function Indicates that a role has all available permissions. Overrides RoleInterface::isAdmin
Role::postLoad public static function Acts on loaded entities. Overrides Entity::postLoad
Role::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
Role::revokePermission public function Revokes a permissions from the user role. Overrides RoleInterface::revokePermission
Role::setIsAdmin public function Sets the role to be an admin role. Overrides RoleInterface::setIsAdmin
Role::setWeight public function Sets the weight to the given value. Overrides RoleInterface::setWeight
RoleInterface::ANONYMOUS_ID constant Role ID for anonymous users; should match what's in the "role" table.
RoleInterface::AUTHENTICATED_ID constant Role ID for authenticated users; should match what's in the "role" table.