interface ConfigurablePluginInterface
Provides an interface for a configurable plugin.
Hierarchy
- interface \Drupal\Component\Plugin\DependentPluginInterface
- interface \Drupal\Component\Plugin\ConfigurablePluginInterface extends \Drupal\Component\Plugin\DependentPluginInterface
Expanded class hierarchy of ConfigurablePluginInterface
All classes that implement ConfigurablePluginInterface
Deprecated
Drupal\Component\Plugin\ConfigurablePluginInterface is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. You should implement ConfigurableInterface and/or DependentPluginInterface directly as needed. If you implement ConfigurableInterface you may choose to implement ConfigurablePluginInterface in Drupal 8 as well for maximum compatibility, however this must be removed prior to Drupal 9.
See also
https://www.drupal.org/node/2946161
Related topics
14 files declare their use of ConfigurablePluginInterface
- AggregatorPluginSettingsBase.php in core/
modules/ aggregator/ src/ Plugin/ AggregatorPluginSettingsBase.php - BlockPluginInterface.php in core/
lib/ Drupal/ Core/ Block/ BlockPluginInterface.php - ConditionInterface.php in core/
lib/ Drupal/ Core/ Condition/ ConditionInterface.php - ConfigurableActionBase.php in core/
lib/ Drupal/ Core/ Action/ ConfigurableActionBase.php - ConfigurablePluginInterfaceTest.php in core/
tests/ Drupal/ Tests/ Component/ Plugin/ ConfigurablePluginInterfaceTest.php
File
-
core/
lib/ Drupal/ Component/ Plugin/ ConfigurablePluginInterface.php, line 19
Namespace
Drupal\Component\PluginView source
interface ConfigurablePluginInterface extends DependentPluginInterface {
/**
* Gets this plugin's configuration.
*
* @return array
* An array of this plugin's configuration.
*/
public function getConfiguration();
/**
* Sets the configuration for this plugin instance.
*
* @param array $configuration
* An associative array containing the plugin's configuration.
*/
public function setConfiguration(array $configuration);
/**
* Gets default configuration for this plugin.
*
* @return array
* An associative array with the default configuration.
*/
public function defaultConfiguration();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
ConfigurablePluginInterface::defaultConfiguration | public | function | Gets default configuration for this plugin. | 1 |
ConfigurablePluginInterface::getConfiguration | public | function | Gets this plugin's configuration. | 1 |
ConfigurablePluginInterface::setConfiguration | public | function | Sets the configuration for this plugin instance. | 1 |
DependentPluginInterface::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | 21 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.