function AccessResult::isForbidden
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Access/AccessResult.php \Drupal\Core\Access\AccessResult::isForbidden()
- 8.9.x core/lib/Drupal/Core/Access/AccessResult.php \Drupal\Core\Access\AccessResult::isForbidden()
- 11.x core/lib/Drupal/Core/Access/AccessResult.php \Drupal\Core\Access\AccessResult::isForbidden()
Checks whether this access result indicates access is explicitly forbidden.
Call this when optimizing an access checker (for hook_entity_access() or a route requirement): if this is TRUE, the final result will be forbidden and no further checking is necessary.
Do not use this method to decide whether someone has access, to convert an access result to boolean: just because this returns FALSE, the end result might be neutral which is not allowed. Always use isAllowed() for this.
Return value
bool When TRUE then isAllowed() and isNeutral() are FALSE.
Overrides AccessResultInterface::isForbidden
See also
\Drupal\Core\Access\AccessResultForbidden
2 calls to AccessResult::isForbidden()
- AccessResult::andIf in core/
lib/ Drupal/ Core/ Access/ AccessResult.php - Combine this access result with another using AND.
- AccessResult::orIf in core/
lib/ Drupal/ Core/ Access/ AccessResult.php - Combine this access result with another using OR.
1 method overrides AccessResult::isForbidden()
- AccessResultForbidden::isForbidden in core/
lib/ Drupal/ Core/ Access/ AccessResultForbidden.php - Checks whether this access result indicates access is explicitly forbidden.
File
-
core/
lib/ Drupal/ Core/ Access/ AccessResult.php, line 192
Class
- AccessResult
- Value object for passing an access result with cacheability metadata.
Namespace
Drupal\Core\AccessCode
public function isForbidden() {
return FALSE;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.