function AccessResultInterface::isForbidden

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Access/AccessResultInterface.php \Drupal\Core\Access\AccessResultInterface::isForbidden()
  2. 10 core/lib/Drupal/Core/Access/AccessResultInterface.php \Drupal\Core\Access\AccessResultInterface::isForbidden()
  3. 11.x core/lib/Drupal/Core/Access/AccessResultInterface.php \Drupal\Core\Access\AccessResultInterface::isForbidden()

Checks whether this access result indicates access is explicitly forbidden.

This is a kill switch — both orIf() and andIf() will result in isForbidden() if either results are isForbidden().

Return value

bool When TRUE then isAllowed() and isNeutral() are FALSE.

2 methods override AccessResultInterface::isForbidden()
AccessResult::isForbidden in core/lib/Drupal/Core/Access/AccessResult.php
UncacheableTestAccessResult::isForbidden in core/tests/Drupal/Tests/Core/Access/AccessResultTest.php
Checks whether this access result indicates access is explicitly forbidden.

File

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

Class

AccessResultInterface
Interface for access result value objects.

Namespace

Drupal\Core\Access

Code

public function isForbidden();

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