RemoveRoleUser.php

Same filename and directory in other branches
  1. 9 core/modules/user/src/Plugin/Action/RemoveRoleUser.php
  2. 10 core/modules/user/src/Plugin/Action/RemoveRoleUser.php
  3. 11.x core/modules/user/src/Plugin/Action/RemoveRoleUser.php

Namespace

Drupal\user\Plugin\Action

File

core/modules/user/src/Plugin/Action/RemoveRoleUser.php

View source
<?php

namespace Drupal\user\Plugin\Action;


/**
 * Removes a role from a user.
 *
 * @Action(
 *   id = "user_remove_role_action",
 *   label = @Translation("Remove a role from the selected users"),
 *   type = "user"
 * )
 */
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();
    }
  }

}

Classes

Title Deprecated Summary
RemoveRoleUser Removes a role from a user.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.