CKEditor5PluginConfigurableInterface
interface CKEditor5PluginConfigurableInterface implements CKEditor5PluginInterface, ConfigurableInterface, PluginFormInterface (View source)
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().
Methods
Gets the definition of the plugin implementation.
Allows a plugin to modify its static configuration.
Sets the configuration for this plugin instance.
Details
string
getPluginId()
Gets the plugin_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
array
getDynamicPluginConfig(array $static_plugin_config, EditorInterface $editor)
Allows a plugin to modify its static configuration.
array
getConfiguration()
Gets this plugin's configuration.
setConfiguration(array $configuration)
Sets the configuration for this plugin instance.
array
defaultConfiguration()
Gets default configuration for this plugin.
array
buildConfigurationForm(array $form, FormStateInterface $form_state)
Form constructor.
Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and
array_parents, see \Drupal\Core\Render\Element\FormElement.
validateConfigurationForm(array $form, FormStateInterface $form_state)
Form validation handler.
submitConfigurationForm(array $form, FormStateInterface $form_state)
Form submission handler.