function User::removeRole

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

Overrides UserInterface::removeRole

File

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

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,
    ]));
    return $this;
}

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