function RemoveRoleUser::execute

Same name in other branches
  1. 9 core/modules/user/src/Plugin/Action/RemoveRoleUser.php \Drupal\user\Plugin\Action\RemoveRoleUser::execute()
  2. 8.9.x core/modules/user/src/Plugin/Action/RemoveRoleUser.php \Drupal\user\Plugin\Action\RemoveRoleUser::execute()
  3. 10 core/modules/user/src/Plugin/Action/RemoveRoleUser.php \Drupal\user\Plugin\Action\RemoveRoleUser::execute()

Overrides ExecutableInterface::execute

File

core/modules/user/src/Plugin/Action/RemoveRoleUser.php, line 21

Class

RemoveRoleUser
Removes a role from a user.

Namespace

Drupal\user\Plugin\Action

Code

public function execute($account = NULL) {
    $rid = $this->configuration['rid'];
    // Skip removing the role from the user if they already don't have it.
    if ($account !== FALSE && $account->hasRole($rid)) {
        // For efficiency manually save the original account before applying
        // any changes.
        $account->original = clone $account;
        $account->removeRole($rid)
            ->save();
    }
}

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