interface CKEditorPluginConfigurableInterface

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

Defines an interface for configurable CKEditor plugins.

This allows a CKEditor plugin to define a settings form. These settings can then be automatically passed on to the corresponding CKEditor instance via CKEditorPluginInterface::getConfig().

Hierarchy

Expanded class hierarchy of CKEditorPluginConfigurableInterface

All classes that implement CKEditorPluginConfigurableInterface

See also

\Drupal\ckeditor\CKEditorPluginInterface

\Drupal\ckeditor\CKEditorPluginButtonsInterface

\Drupal\ckeditor\CKEditorPluginContextualInterface

\Drupal\ckeditor\CKEditorPluginCssInterface

\Drupal\ckeditor\CKEditorPluginBase

\Drupal\ckeditor\CKEditorPluginManager

\Drupal\ckeditor\Annotation\CKEditorPlugin

Plugin API

5 files declare their use of CKEditorPluginConfigurableInterface
CKEditor4to5UpgradeCompletenessTest.php in core/modules/ckeditor5/tests/src/Kernel/CKEditor4to5UpgradeCompletenessTest.php
DrupalImage.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImage.php
Language.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/Language.php
LlamaContextualAndButton.php in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php
StylesCombo.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/StylesCombo.php

File

core/modules/ckeditor/src/CKEditorPluginConfigurableInterface.php, line 24

Namespace

Drupal\ckeditor
View source
interface CKEditorPluginConfigurableInterface extends CKEditorPluginInterface {
    
    /**
     * Returns a settings form to configure this CKEditor plugin.
     *
     * If the plugin's behavior depends on extensive options and/or external data,
     * then the implementing module can choose to provide a separate, global
     * configuration page rather than per-text-editor settings. In that case, this
     * form should provide a link to the separate settings page.
     *
     * @param array $form
     *   An empty form array to be populated with a configuration form, if any.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The state of the entire filter administration form.
     * @param \Drupal\editor\Entity\Editor $editor
     *   A configured text editor object.
     *
     * @return array
     *   A render array for the settings form.
     */
    public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
CKEditorPluginConfigurableInterface::settingsForm public function Returns a settings form to configure this CKEditor plugin. 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.