interface CKEditor5PluginConfigurableInterface

Defines an interface for configurable CKEditor 5 plugins.

This allows a CKEditor 5 plugin to define a settings form. These settings can then be automatically passed on to the corresponding CKEditor 5 instance via CKEditor5PluginInterface::getDynamicPluginConfig().

Hierarchy

Expanded class hierarchy of CKEditor5PluginConfigurableInterface

All classes that implement CKEditor5PluginConfigurableInterface

See also

\Drupal\ckeditor5\Plugin\CKEditor5PluginConfigurableTrait

\Drupal\ckeditor5\CKEditor5PluginInterface

\Drupal\ckeditor5\Plugin\CKEditor5PluginBase

\Drupal\ckeditor5\Plugin\CKEditor5PluginManagerInterface

\Drupal\ckeditor5\Annotation\CKEditor5Plugin

Plugin API

11 files declare their use of CKEditor5PluginConfigurableInterface
Alignment.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Alignment.php
CodeBlock.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/CodeBlock.php
EntityLinkSuggestions.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/EntityLinkSuggestions.php
Heading.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Heading.php
Image.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Image.php

... See full list

File

core/modules/ckeditor5/src/Plugin/CKEditor5PluginConfigurableInterface.php, line 24

Namespace

Drupal\ckeditor5\Plugin
View source
interface CKEditor5PluginConfigurableInterface extends CKEditor5PluginInterface, ConfigurableInterface, PluginFormInterface {

}

Members

Title Sort descending Modifiers Object type Summary Overrides
CKEditor5PluginInterface::getDynamicPluginConfig public function Allows a plugin to modify its static configuration. 1
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 17
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 4
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 4
PluginFormInterface::buildConfigurationForm public function Form constructor. 45
PluginFormInterface::submitConfigurationForm public function Form submission handler. 41
PluginFormInterface::validateConfigurationForm public function Form validation handler. 30
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 5
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3

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