function AccessManagerInterface::checkNamedRoute
Same name in other branches
- 9 core/lib/Drupal/Core/Access/AccessManagerInterface.php \Drupal\Core\Access\AccessManagerInterface::checkNamedRoute()
- 8.9.x core/lib/Drupal/Core/Access/AccessManagerInterface.php \Drupal\Core\Access\AccessManagerInterface::checkNamedRoute()
- 11.x core/lib/Drupal/Core/Access/AccessManagerInterface.php \Drupal\Core\Access\AccessManagerInterface::checkNamedRoute()
Checks a named route with parameters against applicable access check services.
Determines whether the route is accessible or not.
Parameters
string $route_name: The route to check access to.
array $parameters: Optional array of values to substitute into the route path pattern.
\Drupal\Core\Session\AccountInterface $account: (optional) Run access checks for this account. Defaults to the current user.
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 36
Class
- AccessManagerInterface
- Provides an interface for attaching and running access check services.
Namespace
Drupal\Core\AccessCode
public function checkNamedRoute($route_name, array $parameters = [], ?AccountInterface $account = NULL, $return_as_object = FALSE);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.