public function BlockBase::access in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/lib/Drupal/Core/Block/BlockBase.php \Drupal\Core\Block\BlockBase::access()

Indicates whether the block should be shown.

This method allows base implementations to add general access restrictions that should apply to all extending block plugins.

Parameters

\Drupal\Core\Session\AccountInterface $account: The user session for which to check access.

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".

Overrides BlockPluginInterface::access

See also

\Drupal\block\BlockAccessControlHandler

File

core/lib/Drupal/Core/Block/BlockBase.php, line 120

Contains \Drupal\Core\Block\BlockBase.

Class

BlockBase

Defines a base block implementation that most blocks plugins will extend.

Namespace

Drupal\Core\Block

Code

public function access(AccountInterface $account, $return_as_object = FALSE) {
  $access = $this
    ->blockAccess($account);
  return $return_as_object ? $access : $access
    ->isAllowed();
}