public function ContextProviderInterface::getAvailableContexts in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Plugin/Context/ContextProviderInterface.php \Drupal\Core\Plugin\Context\ContextProviderInterface::getAvailableContexts()
2. 9 core/lib/Drupal/Core/Plugin/Context/ContextProviderInterface.php \Drupal\Core\Plugin\Context\ContextProviderInterface::getAvailableContexts()

Gets all available contexts for the purposes of configuration.

When a context aware plugin is being configured, the configuration UI must know which named contexts are potentially available, but does not care about the value, since the value can be different for each request, and might not be available at all during the configuration UI's request.

For example:

// During configuration, there is no specific node to pass as context.
// However, inform the system that a context named 'node' is
// available, and provide its definition, so that context aware plugins
// can be configured to use it. When the plugin, for example a block,
// needs to evaluate the context, the value of this context will be
// supplied by getRuntimeContexts().
$context = EntityContext::fromEntityTypeId('node');
return [
  'node' => $context,
];

Return value

\Drupal\Core\Plugin\Context\ContextInterface[] All available contexts keyed by the unqualified context ID.

See also

\Drupal\Core\Plugin\Context\ContextProviderInterface::getRuntimeContext()

7 methods override ContextProviderInterface::getAvailableContexts()

CurrentLanguageContext::getAvailableContexts in core/lib/Drupal/Core/Language/ContextProvider/CurrentLanguageContext.php

Gets all available contexts for the purposes of configuration.

CurrentUserContext::getAvailableContexts in core/modules/user/src/ContextProvider/CurrentUserContext.php

Gets all available contexts for the purposes of configuration.

FakeViewModeContext::getAvailableContexts in core/modules/layout_builder/tests/modules/layout_builder_fieldblock_test/src/ContextProvider/FakeViewModeContext.php

Gets all available contexts for the purposes of configuration.

IHaveRuntimeContexts::getAvailableContexts in core/modules/layout_builder/tests/modules/layout_builder_test/src/ContextProvider/IHaveRuntimeContexts.php

Gets all available contexts for the purposes of configuration.

MultipleStaticContext::getAvailableContexts in core/modules/block/tests/modules/block_test/src/ContextProvider/MultipleStaticContext.php

Gets all available contexts for the purposes of configuration.

... See full list

File

core/lib/Drupal/Core/Plugin/Context/ContextProviderInterface.php, line 74

Class

ContextProviderInterface

Defines an interface for providing plugin contexts.

Namespace

Drupal\Core\Plugin\Context

Code

public function getAvailableContexts();