interface 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

Plugin API
Using the Plugin API
39 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
CKEditor5PluginInterface.php in core/modules/ckeditor5/src/Plugin/CKEditor5PluginInterface.php
ConditionInterface.php in core/lib/Drupal/Core/Condition/ConditionInterface.php
EditorPluginInterface.php in core/modules/editor/src/Plugin/EditorPluginInterface.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 \Drupal\Component\Plugin\Definition\PluginDefinitionInterface|array
     *   The plugin definition, as returned by the discovery object used by the
     *   plugin manager.
     */
    public function getPluginDefinition();

}

Members

Title Modifiers Object type Summary Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 5
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2