interface ContextAwarePluginInterface in Drupal 10

An override of ContextAwarePluginInterface for documentation purposes.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\Component\Plugin\ContextAwarePluginInterface
    • interface \Drupal\Core\Plugin\ContextAwarePluginInterface

See also

\Drupal\Component\Plugin\ContextAwarePluginInterface

\Drupal\Core\Plugin\ContextAwarePluginTrait

Related topics

Plugin API

Using the Plugin API

20 files declare their use of ContextAwarePluginInterface

BlockAccessControlHandler.php in core/modules/block/src/BlockAccessControlHandler.php

BlockBase.php in core/lib/Drupal/Core/Block/BlockBase.php

BlockForm.php in core/modules/block/src/BlockForm.php

BlockViewBuilder.php in core/modules/block/src/BlockViewBuilder.php

ConfigureBlockFormBase.php in core/modules/layout_builder/src/Form/ConfigureBlockFormBase.php

... See full list

File

core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php, line 15

Namespace

Drupal\Core\Plugin

interface ContextAwarePluginInterface extends ComponentContextAwarePluginInterface {

  /**
   * Gets the context definitions of the plugin.
   *
   * @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface[]
   *   The array of context definitions, keyed by context name.
   */
  public function getContextDefinitions();

  /**
   * Gets a specific context definition of the plugin.
   *
   * @param string $name
   *   The name of the context in the plugin definition.
   *
   * @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface
   *   The definition against which the context value must validate.
   *
   * @throws \Drupal\Component\Plugin\Exception\ContextException
   *   If the requested context is not defined.
   */
  public function getContextDefinition($name);

}