BlockUser.php

Contains \Drupal\user\Plugin\Action\BlockUser.

Namespace

Drupal\user\Plugin\Action

File

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

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

use Drupal\Core\Annotation\Action;
use Drupal\Core\Annotation\Translation;
use Drupal\Core\Action\ActionBase;

/**
 * Blocks a user.
 *
 * @Action(
 *   id = "user_block_user_action",
 *   label = @Translation("Block the selected users"),
 *   type = "user"
 * )
 */
class BlockUser extends ActionBase {

  /**
   * {@inheritdoc}
   */
  public function execute($account = NULL) {

    // Skip blocking user if they are already blocked.
    if ($account !== FALSE && $account->status->value == 1) {

      // For efficiency manually save the original account before applying any
      // changes.
      $account->original = clone $account;
      $account->status = 0;
      $account
        ->save();
    }
  }

}

Classes

Namesort descending Description
BlockUser Blocks a user.