public function AccessManagerInterface::check in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Access/AccessManagerInterface.php \Drupal\Core\Access\AccessManagerInterface::check()
2. 9 core/lib/Drupal/Core/Access/AccessManagerInterface.php \Drupal\Core\Access\AccessManagerInterface::check()

Checks a route against applicable access check services.

Determines whether the route is accessible or not.

Parameters

\Drupal\Core\Routing\RouteMatchInterface $route_match: The route match.

\Drupal\Core\Session\AccountInterface $account: (optional) Run access checks for this account. Defaults to the current user.

\Symfony\Component\HttpFoundation\Request $request: Optional, a request. Only supply this parameter when checking the incoming request, do not specify when checking routes on output.

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".

File

core/lib/Drupal/Core/Access/AccessManagerInterface.php, line 81

Class

AccessManagerInterface

Provides an interface for attaching and running access check services.

Namespace

Drupal\Core\Access

Code

public function check(RouteMatchInterface $route_match, AccountInterface $account = NULL, Request $request = NULL, $return_as_object = FALSE);