public function EditorBase::settingsForm in Zircon Profile 8.0

Same name and namespace in other branches

8 core/modules/editor/src/Plugin/EditorBase.php \Drupal\editor\Plugin\EditorBase::settingsForm()

Returns a settings form to configure this text editor.

If the editor'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-format 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.

Overrides EditorPluginInterface::settingsForm

3 methods override EditorBase::settingsForm()

CKEditor::settingsForm in core/modules/ckeditor/src/Plugin/Editor/CKEditor.php: Returns a settings form to configure this text editor.
TRexEditor::settingsForm in core/modules/editor/tests/modules/src/Plugin/Editor/TRexEditor.php: Returns a settings form to configure this text editor.
UnicornEditor::settingsForm in core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php: Returns a settings form to configure this text editor.

File

core/modules/editor/src/Plugin/EditorBase.php, line 40: Contains \Drupal\editor\Plugin\EditorBase.

Class

EditorBase: Defines a base class from which other modules providing editors may extend.

Namespace

Drupal\editor\Plugin

Code

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

You are here