public function FilterBase::settingsForm in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/filter/src/Plugin/FilterBase.php \Drupal\filter\Plugin\FilterBase::settingsForm()

Generates a filter's settings form.

Parameters

array $form: A minimally prepopulated form array.

\Drupal\Core\Form\FormStateInterface $form_state: The state of the (entire) configuration form.

Return value

array The $form array with additional form elements for the settings of this filter. The submitted form values should match $this->settings.

Overrides FilterInterface::settingsForm

3 methods override FilterBase::settingsForm()

FilterHtml::settingsForm in core/modules/filter/src/Plugin/Filter/FilterHtml.php

Generates a filter's settings form.

FilterUrl::settingsForm in core/modules/filter/src/Plugin/Filter/FilterUrl.php

Generates a filter's settings form.

MediaEmbed::settingsForm in core/modules/media/src/Plugin/Filter/MediaEmbed.php

Generates a filter's settings form.

File

core/modules/filter/src/Plugin/FilterBase.php, line 129

Class

FilterBase

Provides a base class for Filter plugins.

Namespace

Drupal\filter\Plugin

Code

public function settingsForm(array $form, FormStateInterface $form_state) {

  // Implementations should work with and return $form. Returning an empty
  // array here allows the text format administration form to identify whether
  // the filter plugin has any settings form elements.
  return [];
}