class RemoveRoleUser in Drupal 9

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

}

Members

Name	Modifiers	Type	Description	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple	3
ChangeUserRoleBase::$entityType	protected	property	The user role entity type.
ChangeUserRoleBase::access	public	function	Checks object access. Overrides ActionInterface::access
ChangeUserRoleBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ChangeUserRoleBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides ConfigurableActionBase::calculateDependencies
ChangeUserRoleBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ChangeUserRoleBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
ChangeUserRoleBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ChangeUserRoleBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurableActionBase::__construct
ConfigurableActionBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	2
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RemoveRoleUser::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.