function DefaultAccessCheck::access

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Access/DefaultAccessCheck.php \Drupal\Core\Access\DefaultAccessCheck::access()
  2. 10 core/lib/Drupal/Core/Access/DefaultAccessCheck.php \Drupal\Core\Access\DefaultAccessCheck::access()
  3. 11.x core/lib/Drupal/Core/Access/DefaultAccessCheck.php \Drupal\Core\Access\DefaultAccessCheck::access()

Checks access to the route based on the _access parameter.

Parameters

\Symfony\Component\Routing\Route $route: The route to check against.

Return value

\Drupal\Core\Access\AccessResultInterface The access result.

File

core/lib/Drupal/Core/Access/DefaultAccessCheck.php, line 22

Class

DefaultAccessCheck
Allows access to routes to be controlled by an '_access' boolean parameter.

Namespace

Drupal\Core\Access

Code

public function access(Route $route) {
    if ($route->getRequirement('_access') === 'TRUE') {
        return AccessResult::allowed();
    }
    elseif ($route->getRequirement('_access') === 'FALSE') {
        return AccessResult::forbidden();
    }
    else {
        return AccessResult::neutral();
    }
}

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