function User::removeRole

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

Remove a role from a user.

Parameters

string $rid: The role ID to remove.

Overrides UserInterface::removeRole

File

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

Class

User
Defines the user entity class.

Namespace

Drupal\user\Entity

Code

public function removeRole($rid) {
  $this->set('roles', array_diff($this->getRoles(TRUE), [
    $rid,
  ]));
}

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