public function EntityAccessControlHandlerInterface::createAccess

public EntityAccessControlHandlerInterface::createAccess($entity_bundle = NULL, AccountInterface $account = NULL, array $context = array(), $return_as_object = FALSE)

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

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 = array(), $return_as_object = FALSE);