function AccessibleInterface::access
Same name in other branches
- 9 core/lib/Drupal/Core/Access/AccessibleInterface.php \Drupal\Core\Access\AccessibleInterface::access()
- 8.9.x core/lib/Drupal/Core/Access/AccessibleInterface.php \Drupal\Core\Access\AccessibleInterface::access()
- 11.x core/lib/Drupal/Core/Access/AccessibleInterface.php \Drupal\Core\Access\AccessibleInterface::access()
Checks data value access.
Parameters
string $operation: The operation to be performed.
\Drupal\Core\Session\AccountInterface $account: (optional) The user 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".
9 methods override AccessibleInterface::access()
- AccessGroupAnd::access in core/
modules/ block_content/ src/ Access/ AccessGroupAnd.php - Checks data value access.
- EntityBase::access in core/
lib/ Drupal/ Core/ Entity/ EntityBase.php - FieldItemList::access in core/
lib/ Drupal/ Core/ Field/ FieldItemList.php - HelpSearch::access in core/
modules/ help/ src/ Plugin/ Search/ HelpSearch.php - Checks data value access.
- LayoutPreviewAccessAllowed::access in core/
modules/ layout_builder/ src/ Access/ LayoutPreviewAccessAllowed.php - Checks data value access.
File
-
core/
lib/ Drupal/ Core/ Access/ AccessibleInterface.php, line 32
Class
- AccessibleInterface
- Interface for checking access.
Namespace
Drupal\Core\AccessCode
public function access($operation, ?AccountInterface $account = NULL, $return_as_object = FALSE);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.