interface AccessibleInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Access/AccessibleInterface.php \Drupal\Core\Access\AccessibleInterface
  2. 10 core/lib/Drupal/Core/Access/AccessibleInterface.php \Drupal\Core\Access\AccessibleInterface
  3. 11.x core/lib/Drupal/Core/Access/AccessibleInterface.php \Drupal\Core\Access\AccessibleInterface

Interface for checking access.

Hierarchy

Expanded class hierarchy of AccessibleInterface

All classes that implement AccessibleInterface

Related topics

17 files declare their use of AccessibleInterface
AccessGroupAnd.php in core/modules/block_content/src/Access/AccessGroupAnd.php
AccessibleTestingTrait.php in core/modules/block_content/tests/src/Unit/Access/AccessibleTestingTrait.php
BlockContentAccessHandlerTest.php in core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php
BlockContentGetDependencyEvent.php in core/modules/block_content/src/Event/BlockContentGetDependencyEvent.php
EntityAccessCheckTest.php in core/tests/Drupal/Tests/Core/Entity/EntityAccessCheckTest.php

... See full list

File

core/lib/Drupal/Core/Access/AccessibleInterface.php, line 12

Namespace

Drupal\Core\Access
View source
interface AccessibleInterface {
    
    /**
     * Checks data value access.
     *
     * @param string $operation
     *   The operation to be performed.
     * @param \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.
     * @param bool $return_as_object
     *   (optional) Defaults to FALSE.
     *
     * @return 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".
     */
    public function access($operation, AccountInterface $account = NULL, $return_as_object = FALSE);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
AccessibleInterface::access public function Checks data value access. 9

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