interface 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

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

Expanded class hierarchy of CKEditor5PluginElementsSubsetInterface

All classes that implement CKEditor5PluginElementsSubsetInterface

File

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

Namespace

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