class RemoveRoleUser
Same name and namespace in other branches
- 9 core/modules/user/src/Plugin/Action/RemoveRoleUser.php \Drupal\user\Plugin\Action\RemoveRoleUser
- 8.9.x core/modules/user/src/Plugin/Action/RemoveRoleUser.php \Drupal\user\Plugin\Action\RemoveRoleUser
- 10 core/modules/user/src/Plugin/Action/RemoveRoleUser.php \Drupal\user\Plugin\Action\RemoveRoleUser
Removes a role from a user.
Attributes
#[Action(id: 'user_remove_role_action', label: new TranslatableMarkup('Remove a role from the selected users'), type: 'user')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Action\ActionInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Action\ConfigurableActionBase extends \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\PluginFormInterface uses \Drupal\Core\Plugin\ConfigurableTrait implements \Drupal\Core\Action\ActionBase
- class \Drupal\user\Plugin\Action\ChangeUserRoleBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Entity\DependencyTrait implements \Drupal\Core\Action\ConfigurableActionBase
- class \Drupal\user\Plugin\Action\RemoveRoleUser implements \Drupal\user\Plugin\Action\ChangeUserRoleBase
- class \Drupal\user\Plugin\Action\ChangeUserRoleBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Entity\DependencyTrait implements \Drupal\Core\Action\ConfigurableActionBase
- class \Drupal\Core\Action\ConfigurableActionBase extends \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\PluginFormInterface uses \Drupal\Core\Plugin\ConfigurableTrait implements \Drupal\Core\Action\ActionBase
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Action\ActionInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of 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 11
Namespace
Drupal\user\Plugin\ActionView source
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->setOriginal(clone $account);
$account->removeRole($rid)
->save();
}
}
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 ConfigurableTrait::defaultConfiguration | |
| ChangeUserRoleBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | |
| ChangeUserRoleBase::__construct | public | function | Overrides ConfigurableActionBase::__construct | ||
| ConfigurableActionBase::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm | 2 |
| ConfigurableTrait::$configuration | protected | property | Configuration information passed into the plugin. | ||
| ConfigurableTrait::getConfiguration | public | function | Gets this plugin's configuration. | 3 | |
| ConfigurableTrait::setConfiguration | public | function | Sets the configuration for this plugin instance. | 2 | |
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | ||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | ||
| PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
| PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
| RemoveRoleUser::execute | public | function | Executes the plugin. | Overrides ExecutableInterface::execute |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.