interface CKEditorPluginInterface in Drupal 8

Defines an interface for (loading of) CKEditor plugins.

This is the most basic CKEditor plugin interface; it provides the bare minimum information. Solely implementing this interface is not sufficient to be able to enable the plugin though — a CKEditor plugin can either be enabled automatically when a button it provides is present in the toolbar, or when some programmatically defined condition is true. In the former case, implement the CKEditorPluginButtonsInterface interface, in the latter case, implement the CKEditorPluginContextualInterface interface. It is also possible to implement both, for advanced use cases.

Finally, if your plugin must be configurable, you can also implement the CKEditorPluginConfigurableInterface interface.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\ckeditor\CKEditorPluginInterface

See also

\Drupal\ckeditor\CKEditorPluginButtonsInterface

\Drupal\ckeditor\CKEditorPluginContextualInterface

\Drupal\ckeditor\CKEditorPluginConfigurableInterface

\Drupal\ckeditor\CKEditorPluginCssInterface

\Drupal\ckeditor\CKEditorPluginBase

\Drupal\ckeditor\CKEditorPluginManager

\Drupal\ckeditor\Annotation\CKEditorPlugin

Plugin API

2 files declare their use of CKEditorPluginInterface

DrupalImageCaption.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImageCaption.php

Llama.php in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/Llama.php

File

core/modules/ckeditor/src/CKEditorPluginInterface.php, line 32

Namespace

Drupal\ckeditor

interface CKEditorPluginInterface extends PluginInspectionInterface {

  /**
   * Indicates if this plugin is part of the optimized CKEditor build.
   *
   * Plugins marked as internal are implicitly loaded as part of CKEditor.
   *
   * @return bool
   */
  public function isInternal();

  /**
   * Returns a list of plugins this plugin requires.
   *
   * @param \Drupal\editor\Entity\Editor $editor
   *   A configured text editor object.
   *
   * @return array
   *   An unindexed array of plugin names this plugin requires. Each plugin is
   *   is identified by its annotated ID.
   */
  public function getDependencies(Editor $editor);

  /**
   * Returns a list of libraries this plugin requires.
   *
   * These libraries will be attached to the text_format element on which the
   * editor is being loaded.
   *
   * @param \Drupal\editor\Entity\Editor $editor
   *   A configured text editor object.
   *
   * @return array
   *   An array of libraries suitable for usage in a render API #attached
   *   property.
   */
  public function getLibraries(Editor $editor);

  /**
   * Returns the Drupal root-relative file path to the plugin JavaScript file.
   *
   * Note: this does not use a Drupal library because this uses CKEditor's API.
   * @see https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_resourceManager.html#method-addExternal
   *
   * @return string|false
   *   The Drupal root-relative path to the file, FALSE if an internal plugin.
   */
  public function getFile();

  /**
   * Returns the additions to CKEDITOR.config for a specific CKEditor instance.
   *
   * The editor's settings can be retrieved via $editor->getSettings(), but be
   * aware that it may not yet contain plugin-specific settings, because the
   * user may not yet have configured the form.
   * If there are plugin-specific settings (verify with isset()), they can be
   * found at
   * @code
   * $settings = $editor->getSettings();
   * $plugin_specific_settings = $settings['plugins'][$plugin_id];
   * @endcode
   *
   * @param \Drupal\editor\Entity\Editor $editor
   *   A configured text editor object.
   *
   * @return array
   *   A keyed array, whose keys will end up as keys under CKEDITOR.config.
   */
  public function getConfig(Editor $editor);

}

Members

Name	Modifiers	Type	Description	Overrides
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.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2