class RemoveRoleUser in Drupal 10

Removes a role from a user.

Plugin annotation

@Action(
  id = "user_remove_role_action",
  label = @Translation("Remove a role from the selected users"),
  type = "user"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\Core\Action\ConfigurableActionBase implements ConfigurableInterface, DependentPluginInterface, PluginFormInterface
        • class \Drupal\user\Plugin\Action\ChangeUserRoleBase implements ContainerFactoryPluginInterface uses DependencyTrait
          • class \Drupal\user\Plugin\Action\RemoveRoleUser

1 file declares its use of RemoveRoleUser

RemoveRoleUserTest.php in core/modules/user/tests/src/Unit/Plugin/Action/RemoveRoleUserTest.php

File

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

Namespace

Drupal\user\Plugin\Action

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);
      $account
        ->save();
    }
  }

}