function ContextAwarePluginInterface::getContextDefinition

Gets a specific context definition of the plugin.

Parameters

string $name: The name of the context in the plugin definition.

Return value

\Drupal\Component\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.

2 methods override ContextAwarePluginInterface::getContextDefinition()
ContextAwarePluginBase::getContextDefinition in core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php
Gets a specific context definition of the plugin.
ContextAwarePluginInterface::getContextDefinition in core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php
Gets a specific context definition of the plugin.

File

core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php, line 37

Class

ContextAwarePluginInterface
Interface for defining context aware plugins.

Namespace

Drupal\Component\Plugin

Code

public function getContextDefinition($name);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.