class UnblockUser

Same name and namespace in other branches
  1. 11.x core/modules/user/src/Plugin/Action/UnblockUser.php \Drupal\user\Plugin\Action\UnblockUser
  2. 10 core/modules/user/src/Plugin/Action/UnblockUser.php \Drupal\user\Plugin\Action\UnblockUser
  3. 8.9.x core/modules/user/src/Plugin/Action/UnblockUser.php \Drupal\user\Plugin\Action\UnblockUser

Unblocks a user.

Plugin annotation


@Action(
  id = "user_unblock_user_action",
  label = @Translation("Unblock the selected users"),
  type = "user"
)

Hierarchy

Expanded class hierarchy of UnblockUser

File

core/modules/user/src/Plugin/Action/UnblockUser.php, line 17

Namespace

Drupal\user\Plugin\Action
View source
class UnblockUser extends ActionBase {
  
  /**
   * {@inheritdoc}
   */
  public function execute($account = NULL) {
    // Skip unblocking user if they are already unblocked.
    if ($account !== FALSE && $account->isBlocked()) {
      $account->activate();
      $account->save();
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    /** @var \Drupal\user\UserInterface $object */
    $access = $object->status
      ->access('edit', $account, TRUE)
      ->andIf($object->access('update', $account, TRUE));
    return $return_as_object ? $access : $access->isAllowed();
  }

}

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