class BlockUser in Drupal 10

Blocks a user.

Plugin annotation

@Action(
  id = "user_block_user_action",
  label = @Translation("Block the selected users"),
  type = "user"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\user\Plugin\Action\BlockUser

File

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

Namespace

Drupal\user\Plugin\Action

class BlockUser extends ActionBase {

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

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

      // For efficiency manually save the original account before applying any
      // changes.
      $account->original = clone $account;
      $account
        ->block();
      $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();
  }

}