class 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 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 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\AddRoleUser implements \Drupal\user\Plugin\Action\ChangeUserRoleBase

Expanded class hierarchy of AddRoleUser

File

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

Namespace

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

}