1. interface
  2. Drupal
  3. \
  4. ckeditor5
  5. \
  6. Plugin
  7. \
  8. CKEditor5PluginInterface

CKEditor5PluginInterface

interface CKEditor5PluginInterface implements PluginInspectionInterface (View source)

Defines an interface for CKEditor5 plugins.

Methods

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginInspectionInterface
array
getDynamicPluginConfig(array $static_plugin_config, EditorInterface $editor)

Allows a plugin to modify its static configuration.

Details

in PluginInspectionInterface at line 21
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginInspectionInterface at line 30
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

at line 37
array getDynamicPluginConfig(array $static_plugin_config, EditorInterface $editor)

Allows a plugin to modify its static configuration.

Parameters

array $static_plugin_config

The ckeditor5.config entry from the YAML or annotation, if any. If none is specified in the YAML or annotation, then the empty array.
EditorInterface $editor

A configured text editor object.

Return Value

array

Returns the received $static_plugin_config plus dynamic additions or alterations.

See also

CKEditor5AspectsOfCKEditor5Plugin::$config
CKEditor5PluginDefinition::getCKEditor5Config