1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Access
  7. \
  8. AccessibleInterface

AccessibleInterface

interface AccessibleInterface (View source)

Interface for checking access.

Methods

bool|AccessResultInterface
access(string $operation, AccountInterface $account = NULL, bool $return_as_object = FALSE)

Checks data value access.

Details

at line 32
bool|AccessResultInterface access(string $operation, AccountInterface $account = NULL, bool $return_as_object = FALSE)

Checks data value access.

Parameters

string $operation

The operation to be performed.
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|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".