function ContextAwarePluginInterface::setContextValue
Same name in other branches
- 9 core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php \Drupal\Component\Plugin\ContextAwarePluginInterface::setContextValue()
- 8.9.x core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php \Drupal\Component\Plugin\ContextAwarePluginInterface::setContextValue()
- 10 core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php \Drupal\Component\Plugin\ContextAwarePluginInterface::setContextValue()
Sets the value for a defined context.
Parameters
string $name: The name of the context in the plugin definition.
mixed $value: The value to set the context to. The value has to validate against the provided context definition.
Return value
$this A context aware plugin object for chaining.
Throws
\Drupal\Component\Plugin\Exception\ContextException If the value does not pass validation.
File
-
core/
lib/ Drupal/ Component/ Plugin/ ContextAwarePluginInterface.php, line 112
Class
- ContextAwarePluginInterface
- Interface for defining context aware plugins.
Namespace
Drupal\Component\PluginCode
public function setContextValue($name, $value);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.