function DeriverInterface::getDerivativeDefinition
Same name in other branches
- 9 core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php \Drupal\Component\Plugin\Derivative\DeriverInterface::getDerivativeDefinition()
- 10 core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php \Drupal\Component\Plugin\Derivative\DeriverInterface::getDerivativeDefinition()
- 11.x core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php \Drupal\Component\Plugin\Derivative\DeriverInterface::getDerivativeDefinition()
Gets the definition of a derivative plugin.
Parameters
string $derivative_id: The derivative id. The id must uniquely identify the derivative within a given base plugin, but derivative ids can be reused across base plugins.
array|\Drupal\Component\Plugin\Definition\PluginDefinitionInterface $base_plugin_definition: The definition of the base plugin from which the derivative plugin is derived. It is maybe an entire object or just some array, depending on the discovery mechanism.
Return value
array The full definition array of the derivative plugin, typically a merge of $base_plugin_definition with extra derivative-specific information. NULL if the derivative doesn't exist.
14 methods override DeriverInterface::getDerivativeDefinition()
- DeriverBase::getDerivativeDefinition in core/
lib/ Drupal/ Component/ Plugin/ Derivative/ DeriverBase.php - Gets the definition of a derivative plugin.
- EntityDeriver::getDerivativeDefinition in core/
lib/ Drupal/ Core/ Entity/ Plugin/ DataType/ Deriver/ EntityDeriver.php - Gets the definition of a derivative plugin.
- EntityDeriver::getDerivativeDefinition in core/
modules/ rest/ src/ Plugin/ Deriver/ EntityDeriver.php - Gets the definition of a derivative plugin.
- FieldItemDeriver::getDerivativeDefinition in core/
lib/ Drupal/ Core/ Field/ Plugin/ DataType/ Deriver/ FieldItemDeriver.php - Gets the definition of a derivative plugin.
- MigrateEntity::getDerivativeDefinition in core/
modules/ migrate/ src/ Plugin/ Derivative/ MigrateEntity.php - Gets the definition of a derivative plugin.
File
-
core/
lib/ Drupal/ Component/ Plugin/ Derivative/ DeriverInterface.php, line 28
Class
- DeriverInterface
- Provides additional plugin definitions based on an existing definition.
Namespace
Drupal\Component\Plugin\DerivativeCode
public function getDerivativeDefinition($derivative_id, $base_plugin_definition);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.