You are here

interface PluginInspectionInterface in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Component/Plugin/PluginInspectionInterface.php \Drupal\Component\Plugin\PluginInspectionInterface

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

Expanded class hierarchy of PluginInspectionInterface

All classes that implement PluginInspectionInterface

Related topics

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
View source
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

Namesort descending 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