class AddRoleUser

Adds a role to a 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\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

Expanded class hierarchy of AddRoleUser

File

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

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

}

Members