public function User::addRole in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::addRole()

Add a role to a user.

Parameters

string $rid: The role ID to add.

Overrides UserInterface::addRole

File

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

Class

User

Defines the user entity class.

Namespace

Drupal\user\Entity

Code

public function addRole($rid) {
  if (in_array($rid, [
    RoleInterface::AUTHENTICATED_ID,
    RoleInterface::ANONYMOUS_ID,
  ])) {
    throw new \InvalidArgumentException('Anonymous or authenticated role ID must not be assigned manually.');
  }
  $roles = $this
    ->getRoles(TRUE);
  $roles[] = $rid;
  $this
    ->set('roles', array_unique($roles));
}