interface ConfigurableInterface

Same name in other branches
  1. 8.9.x core/lib/Drupal/Component/Plugin/ConfigurableInterface.php \Drupal\Component\Plugin\ConfigurableInterface
  2. 10 core/lib/Drupal/Component/Plugin/ConfigurableInterface.php \Drupal\Component\Plugin\ConfigurableInterface
  3. 11.x core/lib/Drupal/Component/Plugin/ConfigurableInterface.php \Drupal\Component\Plugin\ConfigurableInterface

Provides an interface for a configurable plugin.

Hierarchy

Expanded class hierarchy of ConfigurableInterface

All classes that implement ConfigurableInterface

Related topics

22 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
CKEditor5PluginConfigurableInterface.php in core/modules/ckeditor5/src/Plugin/CKEditor5PluginConfigurableInterface.php
ConditionInterface.php in core/lib/Drupal/Core/Condition/ConditionInterface.php
ConfigurableActionBase.php in core/lib/Drupal/Core/Action/ConfigurableActionBase.php

... See full list

File

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

Namespace

Drupal\Component\Plugin
View source
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

Title Sort descending Modifiers Object type Summary 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

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