Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. AccessibleInterface.php

interface AccessibleInterface

Interface for checking access.

Hierarchy

  • interface \Drupal\Core\Access\AccessibleInterface

Expanded class hierarchy of AccessibleInterface

All classes that implement AccessibleInterface

Related topics

Entity API
Describes how to define and manipulate content and configuration entities.
13 files declare their use of AccessibleInterface
AccessGroupAnd.php in core/modules/block_content/src/Access/AccessGroupAnd.php
BlockContentGetDependencyEvent.php in core/modules/block_content/src/Event/BlockContentGetDependencyEvent.php
EntityInterface.php in core/lib/Drupal/Core/Entity/EntityInterface.php
FieldItemListInterface.php in core/lib/Drupal/Core/Field/FieldItemListInterface.php
HelpSearch.php in core/modules/help/src/Plugin/Search/HelpSearch.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
RSS feed
Powered by Drupal