function DiscoveryInterface::getDefinition
Same name in other branches
- 9 core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php \Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinition()
- 10 core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php \Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinition()
- 11.x core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php \Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinition()
Gets a specific plugin definition.
Parameters
string $plugin_id: A plugin id.
bool $exception_on_invalid: (optional) If TRUE, an invalid plugin ID will throw an exception.
Return value
mixed A plugin definition, or NULL if the plugin ID is invalid and $exception_on_invalid is FALSE.
Throws
\Drupal\Component\Plugin\Exception\PluginNotFoundException Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
2 methods override DiscoveryInterface::getDefinition()
- EntityTypeManagerInterface::getDefinition in core/
lib/ Drupal/ Core/ Entity/ EntityTypeManagerInterface.php - TypedConfigManagerInterface::getDefinition in core/
lib/ Drupal/ Core/ Config/ TypedConfigManagerInterface.php - Gets a specific plugin definition.
File
-
core/
lib/ Drupal/ Component/ Plugin/ Discovery/ DiscoveryInterface.php, line 28
Class
- DiscoveryInterface
- An interface defining the minimum requirements of building a plugin discovery component.
Namespace
Drupal\Component\Plugin\DiscoveryCode
public function getDefinition($plugin_id, $exception_on_invalid = TRUE);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.