interface PluginInspectionInterface in Drupal 8

Plugin interface for providing some metadata inspection.

This interface provides some simple tools for code receiving a plugin to interact with the plugin system.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface

Related topics

Plugin API

Using the Plugin API

44 files declare their use of PluginInspectionInterface

ActionInterface.php in core/lib/Drupal/Core/Action/ActionInterface.php

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

CKEditorPluginInterface.php in core/modules/ckeditor/src/CKEditorPluginInterface.php

ConditionInterface.php in core/lib/Drupal/Core/Condition/ConditionInterface.php

DefaultLazyPluginCollectionTest.php in core/tests/Drupal/Tests/Core/Plugin/DefaultLazyPluginCollectionTest.php

... See full list

File

core/lib/Drupal/Component/Plugin/PluginInspectionInterface.php, line 13

Namespace

Drupal\Component\Plugin

interface PluginInspectionInterface {

  /**
   * Gets the plugin_id of the plugin instance.
   *
   * @return string
   *   The plugin_id of the plugin instance.
   */
  public function getPluginId();

  /**
   * Gets the definition of the plugin implementation.
   *
   * @return array
   *   The plugin definition, as returned by the discovery object used by the
   *   plugin manager.
   */
  public function getPluginDefinition();

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2