function AccessResultInterface::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.

File

core/lib/Drupal/Core/Access/AccessResultInterface.php, line 48

Class

AccessResultInterface

Interface for access result value objects.

Namespace

Code

public function isForbidden();