Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Access/AccessResult.php \Drupal\Core\Access\AccessResult::forbiddenIf()
2. 8.9.x core/lib/Drupal/Core/Access/AccessResult.php \Drupal\Core\Access\AccessResult::forbiddenIf()
3. 11.x core/lib/Drupal/Core/Access/AccessResult.php \Drupal\Core\Access\AccessResult::forbiddenIf()

Creates a forbidden or neutral access result.

Parameters

bool $condition: The condition to evaluate.

string|null $reason: (optional) The reason why access is forbidden. Intended for developers, hence not translatable

Return value

\Drupal\Core\Access\AccessResult If $condition is TRUE, isForbidden() will be TRUE, otherwise isNeutral() will be TRUE.

2 calls to AccessResult::forbiddenIf()

AccessResultTest::testAccessConditionallyForbidden in core/tests/Drupal/Tests/Core/Access/AccessResultTest.php

@covers ::forbiddenIf[[api-linebreak]] @covers ::isAllowed[[api-linebreak]] @covers ::isForbidden[[api-linebreak]] @covers ::isNeutral[[api-linebreak]]

AccessResultTest::testAccessForbiddenReason in core/tests/Drupal/Tests/Core/Access/AccessResultTest.php

@covers ::forbidden[[api-linebreak]]

File

core/lib/Drupal/Core/Access/AccessResult.php, line 96

Class

AccessResult

Value object for passing an access result with cacheability metadata.

Namespace

Drupal\Core\Access

Code

public static function forbiddenIf($condition, $reason = NULL) {
  return $condition ? static::forbidden($reason) : static::neutral();
}

---