function CKEditorPluginConfigurableInterface::settingsForm

Same name in other branches
  1. 9 core/modules/ckeditor/src/CKEditorPluginConfigurableInterface.php \Drupal\ckeditor\CKEditorPluginConfigurableInterface::settingsForm()

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.

Parameters

array $form: An empty form array to be populated with a configuration form, if any.

\Drupal\Core\Form\FormStateInterface $form_state: The state of the entire filter administration form.

\Drupal\editor\Entity\Editor $editor: A configured text editor object.

Return value

array A render array for the settings form.

4 methods override CKEditorPluginConfigurableInterface::settingsForm()
DrupalImage::settingsForm in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImage.php
Language::settingsForm in core/modules/ckeditor/src/Plugin/CKEditorPlugin/Language.php
Returns a settings form to configure this CKEditor plugin.
LlamaContextualAndButton::settingsForm in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php
Returns a settings form to configure this CKEditor plugin.
StylesCombo::settingsForm in core/modules/ckeditor/src/Plugin/CKEditorPlugin/StylesCombo.php
Returns a settings form to configure this CKEditor plugin.

File

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

Class

CKEditorPluginConfigurableInterface
Defines an interface for configurable CKEditor plugins.

Namespace

Drupal\ckeditor

Code

public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.