interface ConfigurableInterface in Drupal 9

Provides an interface for a configurable plugin.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface

Related topics

Plugin API

Using the Plugin API

20 files declare their use of ConfigurableInterface

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

ConfigurableSearchPluginInterface.php in core/modules/search/src/Plugin/ConfigurableSearchPluginInterface.php

... See full list

File

core/lib/Drupal/Component/Plugin/ConfigurableInterface.php, line 10

Namespace

Drupal\Component\Plugin

interface ConfigurableInterface {

  /**
   * 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

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15