function User::hasRole

Same name and namespace in other branches
  1. 9 core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::hasRole()
  2. 8.9.x core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::hasRole()
  3. 11.x core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::hasRole()

Whether a user has a certain role.

@todo in Drupal 11, move method to Drupal\Core\Session\AccountInterface.

Parameters

string $rid: The role ID to check.

Return value

bool Returns TRUE if the user has the role, otherwise FALSE.

Overrides UserInterface::hasRole

File

core/modules/user/src/Entity/User.php, line 195

Class

User
Defines the user entity class.

Namespace

Drupal\user\Entity

Code

public function hasRole($rid) {
    return in_array($rid, $this->getRoles());
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.