AccessCheckInterface.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/Access/AccessCheckInterface.php
  2. 8.9.x core/lib/Drupal/Core/Access/AccessCheckInterface.php
  3. 11.x core/lib/Drupal/Core/Access/AccessCheckInterface.php

Namespace

Drupal\Core\Access

File

core/lib/Drupal/Core/Access/AccessCheckInterface.php

View source
<?php

namespace Drupal\Core\Access;

use Symfony\Component\Routing\Route;
use Drupal\Core\Routing\Access\AccessInterface as RoutingAccessInterface;

/**
 * An access check service determines access rules for particular routes.
 */
interface AccessCheckInterface extends RoutingAccessInterface {
    
    /**
     * Declares whether the access check applies to a specific route or not.
     *
     * @param \Symfony\Component\Routing\Route $route
     *   The route to consider attaching to.
     *
     * @return bool
     *   TRUE if this access checker applies to this route.
     */
    public function applies(Route $route);

}

Interfaces

Title Deprecated Summary
AccessCheckInterface An access check service determines access rules for particular routes.

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