interface PluginInspectionInterface

Same name in other branches
  1. 9 core/lib/Drupal/Component/Plugin/PluginInspectionInterface.php \Drupal\Component\Plugin\PluginInspectionInterface
  2. 8.9.x core/lib/Drupal/Component/Plugin/PluginInspectionInterface.php \Drupal\Component\Plugin\PluginInspectionInterface
  3. 11.x 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

43 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
CKEditor4To5UpgradePluginInterface.php in core/modules/ckeditor5/src/Plugin/CKEditor4To5UpgradePluginInterface.php
CKEditor5PluginInterface.php in core/modules/ckeditor5/src/Plugin/CKEditor5PluginInterface.php
ConditionInterface.php in core/lib/Drupal/Core/Condition/ConditionInterface.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 Sort descending Modifiers Object type Summary Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.