class CKEditor5PluginDefault

Same name in other branches
  1. 9 core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefault.php \Drupal\ckeditor5\Plugin\CKEditor5PluginDefault
  2. 11.x core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefault.php \Drupal\ckeditor5\Plugin\CKEditor5PluginDefault

Defines the default CKEditor 5 plugin implementation.

When a CKEditor 5 plugin is not configurable nor has dynamic plugin configuration, no custom code needs to be written: this default implementation will be used under the hood.

Hierarchy

Expanded class hierarchy of CKEditor5PluginDefault

See also

@see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$class

15 files declare their use of CKEditor5PluginDefault
Alignment.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Alignment.php
CodeBlock.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/CodeBlock.php
DrupalAspectsOfCKEditor5Plugin.php in core/modules/ckeditor5/src/Annotation/DrupalAspectsOfCKEditor5Plugin.php
DrupalAspectsOfCKEditor5Plugin.php in core/modules/ckeditor5/src/Attribute/DrupalAspectsOfCKEditor5Plugin.php
GlobalAttribute.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/GlobalAttribute.php

... See full list

File

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

Namespace

Drupal\ckeditor5\Plugin
View source
class CKEditor5PluginDefault extends PluginBase implements CKEditor5PluginInterface {
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        // Ensure the configuration is set as expected for configurable plugins.
        if ($this instanceof CKEditor5PluginConfigurableInterface) {
            $this->setConfiguration($configuration);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDynamicPluginConfig(array $static_plugin_config, EditorInterface $editor) : array {
        return $static_plugin_config;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CKEditor5PluginDefault::getDynamicPluginConfig public function Allows a plugin to modify its static configuration. Overrides CKEditor5PluginInterface::getDynamicPluginConfig 11
CKEditor5PluginDefault::__construct public function 3
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.