You are here

public function TextWithSummaryItem::fieldSettingsForm in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php \Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::fieldSettingsForm()
  2. 9 core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php \Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::fieldSettingsForm()

Returns a form for the field-level settings.

Invoked from \Drupal\field_ui\Form\FieldConfigEditForm to allow administrators to configure field-level settings.

Parameters

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

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

Return value

array The form definition for the field settings.

Overrides FieldItemBase::fieldSettingsForm

File

core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php, line 88

Class

TextWithSummaryItem
Plugin implementation of the 'text_with_summary' field type.

Namespace

Drupal\text\Plugin\Field\FieldType

Code

public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
  $element = [];
  $settings = $this
    ->getSettings();
  $element['display_summary'] = [
    '#type' => 'checkbox',
    '#title' => t('Summary input'),
    '#default_value' => $settings['display_summary'],
    '#description' => t('This allows authors to input an explicit summary, to be displayed instead of the automatically trimmed text when using the "Summary or trimmed" display type.'),
  ];
  $element['required_summary'] = [
    '#type' => 'checkbox',
    '#title' => t('Require summary'),
    '#description' => t('The summary will also be visible when marked as required.'),
    '#default_value' => $settings['required_summary'],
  ];
  return $element;
}