class ConfigurablePluginBase

Base class for plugins that are configurable.

Provides boilerplate methods for implementing Drupal\Component\Plugin\ConfigurableInterface. Configurable plugins may extend this base class instead of PluginBase. If your plugin must extend a different base class, you may use \Drupal\Component\Plugin\ConfigurableTrait directly and call setConfiguration() in your constructor.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Plugin\ConfigurablePluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Component\Plugin\ConfigurableInterface uses \Drupal\Core\Plugin\ConfigurableTrait

Expanded class hierarchy of ConfigurablePluginBase

See also

\Drupal\Core\Plugin\ConfigurableTrait

File

core/lib/Drupal/Core/Plugin/ConfigurablePluginBase.php, line 20

Namespace

abstract class ConfigurablePluginBase extends PluginBase implements ConfigurableInterface {
    use ConfigurableTrait;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->setConfiguration($configuration);
    }

}