interface CKEditor5PluginElementsSubsetInterface in Drupal 10

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

• interface \Drupal\ckeditor5\Plugin\CKEditor5PluginInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\ckeditor5\Plugin\CKEditor5PluginConfigurableInterface
    • interface \Drupal\ckeditor5\Plugin\CKEditor5PluginElementsSubsetInterface

8 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

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

Name	Modifiers	Type	Description	Overrides
CKEditor5PluginElementsSubsetInterface::getElementsSubset	public	function	Returns a configured subset of the elements supported by this plugin.
CKEditor5PluginInterface::getDynamicPluginConfig	public	function	Allows a plugin to modify its static configuration.	1
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	3
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	3
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	3
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	9
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	9
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	7
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	1
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	1