function EntityAccessControlHandlerInterface::createAccess

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php \Drupal\Core\Entity\EntityAccessControlHandlerInterface::createAccess()
  2. 8.9.x core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php \Drupal\Core\Entity\EntityAccessControlHandlerInterface::createAccess()
  3. 11.x core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php \Drupal\Core\Entity\EntityAccessControlHandlerInterface::createAccess()

Checks access to create an entity.

Parameters

string $entity_bundle: (optional) The bundle of the entity. Required if the entity supports bundles, defaults to NULL otherwise.

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

array $context: (optional) An array of key-value pairs to pass additional context when needed.

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::createAccess()
EntityAccessControlHandler::createAccess in core/lib/Drupal/Core/Entity/EntityAccessControlHandler.php
Checks access to create an entity.

File

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

Class

EntityAccessControlHandlerInterface
Defines an interface for entity access control handlers.

Namespace

Drupal\Core\Entity

Code

public function createAccess($entity_bundle = NULL, ?AccountInterface $account = NULL, array $context = [], $return_as_object = FALSE);

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