function ActionInterface::access
Same name in other branches
- 9 core/lib/Drupal/Core/Action/ActionInterface.php \Drupal\Core\Action\ActionInterface::access()
- 8.9.x core/lib/Drupal/Core/Action/ActionInterface.php \Drupal\Core\Action\ActionInterface::access()
- 11.x core/lib/Drupal/Core/Action/ActionInterface.php \Drupal\Core\Action\ActionInterface::access()
Checks object access.
Parameters
mixed $object: The object to execute the action on.
\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".
20 methods override ActionInterface::access()
- ActionAjaxTest::access in core/
modules/ action/ tests/ action_form_ajax_test/ src/ Plugin/ Action/ ActionAjaxTest.php - Checks object access.
- AssignOwnerNode::access in core/
modules/ action/ src/ Plugin/ Action/ AssignOwnerNode.php - Checks object access.
- BatchUserAction::access in core/
modules/ views/ tests/ modules/ user_batch_action_test/ src/ Plugin/ Action/ BatchUserAction.php - Checks object access.
- BlockUser::access in core/
modules/ user/ src/ Plugin/ Action/ BlockUser.php - Checks object access.
- CancelUser::access in core/
modules/ user/ src/ Plugin/ Action/ CancelUser.php - Checks object access.
File
-
core/
lib/ Drupal/ Core/ Action/ ActionInterface.php, line 59
Class
- ActionInterface
- Provides an interface for an Action plugin.
Namespace
Drupal\Core\ActionCode
public function access($object, ?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.