interface CKEditorPluginCssInterface

Same name and namespace in other branches
  1. 8.9.x core/modules/ckeditor/src/CKEditorPluginCssInterface.php \Drupal\ckeditor\CKEditorPluginCssInterface

Defines an interface for CKEditor plugins with associated CSS.

This allows a CKEditor plugin to add additional CSS in iframe CKEditor instances without needing to implement hook_ckeditor_css_alter().

Hierarchy

Expanded class hierarchy of CKEditorPluginCssInterface

All classes that implement CKEditorPluginCssInterface

See also

\Drupal\ckeditor\CKEditorPluginInterface

\Drupal\ckeditor\CKEditorPluginButtonsInterface

\Drupal\ckeditor\CKEditorPluginContextualInterface

\Drupal\ckeditor\CKEditorPluginConfigurableInterface

\Drupal\ckeditor\CKEditorPluginBase

\Drupal\ckeditor\CKEditorPluginManager

\Drupal\ckeditor\Annotation\CKEditorPlugin

Plugin API

4 files declare their use of CKEditorPluginCssInterface
DrupalImageCaption.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImageCaption.php
DrupalMedia.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalMedia.php
Language.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/Language.php
LlamaCss.php in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaCss.php

File

core/modules/ckeditor/src/CKEditorPluginCssInterface.php, line 22

Namespace

Drupal\ckeditor
View source 
interface CKEditorPluginCssInterface extends CKEditorPluginInterface {
    
    /**
     * Retrieves enabled plugins' iframe instance CSS files.
     *
     * Note: this does not use a Drupal asset library because this CSS will be
     * loaded by CKEditor, not by Drupal.
     *
     * @param \Drupal\editor\Entity\Editor $editor
     *   A configured text editor object.
     *
     * @return string[]
     *   An array of CSS files. This is a flat list of file paths relative to
     *   the Drupal root.
     */
    public function getCssFiles(Editor $editor);

}

Members

Title Modifiers Object type Summary Overrides
CKEditorPluginCssInterface::getCssFiles public function Retrieves enabled plugins' iframe instance CSS files. 4
CKEditorPluginInterface::getConfig public function Returns the additions to CKEDITOR.config for a specific CKEditor instance. 9
CKEditorPluginInterface::getDependencies public function Returns a list of plugins this plugin requires. 4
CKEditorPluginInterface::getFile public function Returns the Drupal root-relative file path to the plugin JavaScript file. 9
CKEditorPluginInterface::getLibraries public function Returns a list of libraries this plugin requires. 4
CKEditorPluginInterface::isInternal public function Indicates if this plugin is part of the optimized CKEditor build. 4
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.