function EntityAccessControlHandlerInterface::access
Checks access to an operation on a given entity or entity translation.
Use \Drupal\Core\Entity\EntityAccessControlHandlerInterface::createAccess() to check access to create an entity.
Parameters
\Drupal\Core\Entity\EntityInterface $entity: The entity for which to check access.
string $operation: The operation access should be checked for. Usually one of "view", "view label", "update" or "delete".
\Drupal\Core\Session\AccountInterface $account: (optional) The user session 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".
1 method overrides EntityAccessControlHandlerInterface::access()
- EntityAccessControlHandler::access in core/
lib/ Drupal/ Core/ Entity/ EntityAccessControlHandler.php - Checks access to an operation on a given entity or entity translation.
File
-
core/
lib/ Drupal/ Core/ Entity/ EntityAccessControlHandlerInterface.php, line 39
Class
- EntityAccessControlHandlerInterface
- Defines an interface for entity access control handlers.
Namespace
Drupal\Core\EntityCode
public function access(EntityInterface $entity, $operation, ?AccountInterface $account = NULL, $return_as_object = FALSE);