You are here

public function CancelUser::access in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/user/src/Plugin/Action/CancelUser.php \Drupal\user\Plugin\Action\CancelUser::access()

Checks object access.

Parameters

mixed $object: The object to execute the action on.

\Drupal\Core\Session\AccountInterface $account: (optional) The user for which to check access, or NULL to check access for the current user. Defaults to NULL.

bool $return_as_object: (optional) Defaults to FALSE.

Return value

bool|\Drupal\Core\Access\AccessResultInterface The access result. Returns a boolean if $return_as_object is FALSE (this is the default) and otherwise an AccessResultInterface object. When a boolean is returned, the result of AccessInterface::isAllowed() is returned, i.e. TRUE means access is explicitly allowed, FALSE means access is either explicitly forbidden or "no opinion".

Overrides ActionInterface::access

File

core/modules/user/src/Plugin/Action/CancelUser.php, line 88

Class

CancelUser
Cancels a user account.

Namespace

Drupal\user\Plugin\Action

Code

public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {

  /** @var \Drupal\user\UserInterface $object */
  return $object
    ->access('delete', $account, $return_as_object);
}