interface CKEditor5PluginInterface

Same name and namespace in other branches
  1. 9 core/modules/ckeditor5/src/Plugin/CKEditor5PluginInterface.php \Drupal\ckeditor5\Plugin\CKEditor5PluginInterface
  2. 10 core/modules/ckeditor5/src/Plugin/CKEditor5PluginInterface.php \Drupal\ckeditor5\Plugin\CKEditor5PluginInterface

Defines an interface for CKEditor 5 plugins.

Hierarchy

Expanded class hierarchy of CKEditor5PluginInterface

All classes that implement CKEditor5PluginInterface

See also

\Drupal\ckeditor5\Plugin\CKEditor5PluginBase

\Drupal\ckeditor5\Plugin\CKEditor5PluginConfigurableInterface

\Drupal\ckeditor5\Plugin\CKEditor5PluginManagerInterface

\Drupal\ckeditor5\Annotation\CKEditor5Plugin

Plugin API

File

core/modules/ckeditor5/src/Plugin/CKEditor5PluginInterface.php, line 19

Namespace

Drupal\ckeditor5\Plugin
View source 
interface CKEditor5PluginInterface extends PluginInspectionInterface {
    
    /**
     * Allows a plugin to modify its static configuration.
     *
     * @param 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.
     * @param \Drupal\editor\EditorInterface $editor
     *   A configured text editor object.
     *
     * @return array
     *   Returns the received $static_plugin_config plus dynamic additions or
     *   alterations.
     *
     * @see \Drupal\ckeditor5\Annotation\CKEditor5AspectsOfCKEditor5Plugin::$config
     * @see \Drupal\ckeditor5\Plugin\CKEditor5PluginDefinition::getCKEditor5Config()
     */
    public function getDynamicPluginConfig(array $static_plugin_config, EditorInterface $editor) : array;

}

Members

Title Modifiers Object type Summary Overrides
CKEditor5PluginInterface::getDynamicPluginConfig public function Allows a plugin to modify its static configuration. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

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