public function EntityAccessControlHandlerInterface::fieldAccess in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php \Drupal\Core\Entity\EntityAccessControlHandlerInterface::fieldAccess()

Checks access to an operation on a given entity field.

This method does not determine whether access is granted to the entity itself, only the specific field. Callers are responsible for ensuring that entity access is also respected, for example by using \Drupal\Core\Entity\EntityAccessControlHandlerInterface::access().

Parameters

string $operation: The operation access should be checked for. Usually one of "view" or "edit".

\Drupal\Core\Field\FieldDefinitionInterface $field_definition: The field definition.

\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.

\Drupal\Core\Field\FieldItemListInterface $items: (optional) The field values for which to check access, or NULL if access is checked for the field definition, without any specific value available. 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".

See also

\Drupal\Core\Entity\EntityAccessControlHandlerInterface::access()

1 method overrides EntityAccessControlHandlerInterface::fieldAccess()

EntityAccessControlHandler::fieldAccess in core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php

Checks access to an operation on a given entity field.

File

core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php, line 112

Class

EntityAccessControlHandlerInterface

Defines an interface for entity access control handlers.

Namespace

Drupal\Core\Entity

Code

public function fieldAccess($operation, FieldDefinitionInterface $field_definition, AccountInterface $account = NULL, FieldItemListInterface $items = NULL, $return_as_object = FALSE);