class AddRoleUser
Same name in other branches
- 9 core/modules/user/src/Plugin/Action/AddRoleUser.php \Drupal\user\Plugin\Action\AddRoleUser
- 10 core/modules/user/src/Plugin/Action/AddRoleUser.php \Drupal\user\Plugin\Action\AddRoleUser
- 11.x core/modules/user/src/Plugin/Action/AddRoleUser.php \Drupal\user\Plugin\Action\AddRoleUser
Adds a role to a user.
Plugin annotation
@Action(
id = "user_add_role_action",
label = @Translation("Add a role to the selected users"),
type = "user"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
- class \Drupal\Core\Action\ConfigurableActionBase extends \Drupal\Core\Action\ActionBase implements \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Component\Plugin\ConfigurablePluginInterface, \Drupal\Core\Plugin\PluginFormInterface
- class \Drupal\user\Plugin\Action\ChangeUserRoleBase extends \Drupal\Core\Action\ConfigurableActionBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Entity\DependencyTrait
- class \Drupal\user\Plugin\Action\AddRoleUser extends \Drupal\user\Plugin\Action\ChangeUserRoleBase
- class \Drupal\user\Plugin\Action\ChangeUserRoleBase extends \Drupal\Core\Action\ConfigurableActionBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Entity\DependencyTrait
- class \Drupal\Core\Action\ConfigurableActionBase extends \Drupal\Core\Action\ActionBase implements \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Component\Plugin\ConfigurablePluginInterface, \Drupal\Core\Plugin\PluginFormInterface
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of AddRoleUser
1 file declares its use of AddRoleUser
- AddRoleUserTest.php in core/
modules/ user/ tests/ src/ Unit/ Plugin/ Action/ AddRoleUserTest.php
File
-
core/
modules/ user/ src/ Plugin/ Action/ AddRoleUser.php, line 14
Namespace
Drupal\user\Plugin\ActionView source
class AddRoleUser extends ChangeUserRoleBase {
/**
* {@inheritdoc}
*/
public function execute($account = NULL) {
$rid = $this->configuration['rid'];
// Skip adding the role to the user if they already have it.
if ($account !== FALSE && !$account->hasRole($rid)) {
// For efficiency manually save the original account before applying
// any changes.
$account->original = clone $account;
$account->addRole($rid);
$account->save();
}
}
}
Members
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.