interface CKEditor5PluginElementsSubsetInterface

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

Defines an interface for plugins that can support an elements subset.

Plugins can support multiple elements in the `elements` property of their definition. A text format may want to use a given plugin without supporting every supported element. Plugins that implement this interface return a subset based on the configuration in the Text Editor's settings.

Hierarchy

Expanded class hierarchy of CKEditor5PluginElementsSubsetInterface

All classes that implement CKEditor5PluginElementsSubsetInterface

10 files declare their use of CKEditor5PluginElementsSubsetInterface
Alignment.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Alignment.php
CKEditor4to5UpgradeCompletenessTest.php in core/modules/ckeditor5/tests/src/Kernel/CKEditor4to5UpgradeCompletenessTest.php
FundamentalCompatibilityConstraintValidator.php in core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php
Heading.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Heading.php
ListPlugin.php in core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/ListPlugin.php

... See full list

File

core/modules/ckeditor5/src/Plugin/CKEditor5PluginElementsSubsetInterface.php, line 15

Namespace

Drupal\ckeditor5\Plugin
View source
interface CKEditor5PluginElementsSubsetInterface extends CKEditor5PluginConfigurableInterface {
    
    /**
     * Returns a configured subset of the elements supported by this plugin.
     *
     * @return string[]
     *   An array of supported elements.
     */
    public function getElementsSubset() : array;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
CKEditor5PluginElementsSubsetInterface::getElementsSubset public function Returns a configured subset of the elements supported by this plugin. 7

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