function EntityAccessControlHandler::checkAccess

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php \Drupal\Core\Entity\EntityAccessControlHandler::checkAccess()
  2. 10 core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php \Drupal\Core\Entity\EntityAccessControlHandler::checkAccess()
  3. 8.9.x core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php \Drupal\Core\Entity\EntityAccessControlHandler::checkAccess()

Performs access checks.

This method is supposed to be overwritten by extending classes that do their own custom access checking.

Parameters

\Drupal\Core\Entity\EntityInterface $entity: The entity for which to check access.

string $operation: The entity operation. Usually one of 'view', 'view label', 'update' or 'delete'.

\Drupal\Core\Session\AccountInterface $account: The user for which to check access.

Return value

\Drupal\Core\Access\AccessResultInterface The access result.

5 methods override EntityAccessControlHandler::checkAccess()
EntityFormDisplayAccessControlHandler::checkAccess in core/lib/Drupal/Core/Entity/Entity/Access/EntityFormDisplayAccessControlHandler.php
Performs access checks.
EntityTestAccessControlHandler::checkAccess in core/modules/system/tests/modules/entity_test/src/EntityTestAccessControlHandler.php
Performs access checks.
MediaAccessControlHandler::checkAccess in core/modules/media/src/MediaAccessControlHandler.php
Performs access checks.
TourAccessControlHandler::checkAccess in core/modules/tour/src/TourAccessControlHandler.php
Performs access checks.
UserAccessControlHandler::checkAccess in core/modules/user/src/UserAccessControlHandler.php
Performs access checks.

File

core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php, line 158

Class

EntityAccessControlHandler
Defines a default implementation for entity access control handler.

Namespace

Drupal\Core\Entity

Code

protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
  if ($operation == 'delete' && $entity->isNew()) {
    return AccessResult::forbidden()->addCacheableDependency($entity);
  }
  if ($admin_permission = $this->entityType
    ->getAdminPermission()) {
    return AccessResult::allowedIfHasPermission($account, $admin_permission);
  }
  else {
    // No opinion.
    return AccessResult::neutral();
  }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.