public function ContextProviderInterface::getRuntimeContexts 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::getRuntimeContexts()
2. 9 core/lib/Drupal/Core/Plugin/Context/ContextProviderInterface.php \Drupal\Core\Plugin\Context\ContextProviderInterface::getRuntimeContexts()

Gets runtime context values for the given context IDs.

For context-aware plugins to function correctly, all of the contexts that they require must be populated with values. So this method should set a value for each context that it adds. For example:

  // Determine a specific node to pass as context to a block.
  $node = ...

  // Set that specific node as the value of the 'node' context.
  $context = EntityContext::fromEntity($node);
  return ['node' => $context];

On the other hand, there are cases, on which providers no longer are possible to provide context objects, even without the value, so the caller should not expect it.

Parameters

string[] $unqualified_context_ids: The requested context IDs. The context provider must only return contexts for those IDs.

Return value

\Drupal\Core\Plugin\Context\ContextInterface[] The determined available contexts, keyed by the unqualified context_id.

See also

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

7 methods override ContextProviderInterface::getRuntimeContexts()

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

Gets runtime context values for the given context IDs.

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

Gets runtime context values for the given context IDs.

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

Gets runtime context values for the given context IDs.

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

Gets runtime context values for the given context IDs.

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

Gets runtime context values for the given context IDs.

... See full list

File

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

Class

ContextProviderInterface

Defines an interface for providing plugin contexts.

Namespace

Drupal\Core\Plugin\Context

Code

public function getRuntimeContexts(array $unqualified_context_ids);