RemoveRoleUser.php

Same filename in other branches
  1. 9 core/modules/user/src/Plugin/Action/RemoveRoleUser.php
  2. 8.9.x core/modules/user/src/Plugin/Action/RemoveRoleUser.php
  3. 11.x core/modules/user/src/Plugin/Action/RemoveRoleUser.php

Namespace

Drupal\user\Plugin\Action

File

core/modules/user/src/Plugin/Action/RemoveRoleUser.php

View source
<?php

namespace Drupal\user\Plugin\Action;

use Drupal\Core\Action\Attribute\Action;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Removes a role from a user.
 */
class RemoveRoleUser extends ChangeUserRoleBase {
    
    /**
     * {@inheritdoc}
     */
    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();
        }
    }

}

Classes

Title Deprecated Summary
RemoveRoleUser Removes a role from a user.

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