You are here

public function EntityReferenceAutocompleteWidget::settingsForm in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php \Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget::settingsForm()

Returns a form to configure settings for the widget.

Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the widget. The field_ui module takes care of handling submitted form values.

Parameters

array $form: The form where the settings form is being included in.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form definition for the widget settings.

Overrides WidgetBase::settingsForm

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php, line 40

Class

EntityReferenceAutocompleteWidget
Plugin implementation of the 'entity_reference_autocomplete' widget.

Namespace

Drupal\Core\Field\Plugin\Field\FieldWidget

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $element['match_operator'] = [
    '#type' => 'radios',
    '#title' => t('Autocomplete matching'),
    '#default_value' => $this
      ->getSetting('match_operator'),
    '#options' => $this
      ->getMatchOperatorOptions(),
    '#description' => t('Select the method used to collect autocomplete suggestions. Note that <em>Contains</em> can cause performance issues on sites with thousands of entities.'),
  ];
  $element['match_limit'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Number of results'),
    '#default_value' => $this
      ->getSetting('match_limit'),
    '#min' => 0,
    '#description' => $this
      ->t('The number of suggestions that will be listed. Use <em>0</em> to remove the limit.'),
  ];
  $element['size'] = [
    '#type' => 'number',
    '#title' => t('Size of textfield'),
    '#default_value' => $this
      ->getSetting('size'),
    '#min' => 1,
    '#required' => TRUE,
  ];
  $element['placeholder'] = [
    '#type' => 'textfield',
    '#title' => t('Placeholder'),
    '#default_value' => $this
      ->getSetting('placeholder'),
    '#description' => t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'),
  ];
  return $element;
}