RemoveRoleUser.php

Contains \Drupal\user\Plugin\Action\RemoveRoleUser.

Namespace

Drupal\user\Plugin\Action

File

drupal/core/modules/user/lib/Drupal/user/Plugin/Action/RemoveRoleUser.php
View source
<?php

/**
 * @file
 * Contains \Drupal\user\Plugin\Action\RemoveRoleUser.
 */
namespace Drupal\user\Plugin\Action;

use Drupal\Core\Annotation\Action;
use Drupal\Core\Annotation\Translation;
use Drupal\user\Plugin\Action\ChangeUserRoleBase;

/**
 * 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

Namesort descending Description
RemoveRoleUser Removes a role from a user.