public function DateTimeDefaultFormatter::settingsSummary in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeDefaultFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter::settingsSummary()
2. 9 core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeDefaultFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter::settingsSummary()

Returns a short summary for the current formatter settings.

If an empty result is returned, a UI can still be provided to display a settings form in case the formatter has configurable settings.

Return value

string[] A short summary of the formatter settings.

Overrides DateTimeFormatterBase::settingsSummary

1 method overrides DateTimeDefaultFormatter::settingsSummary()

DateRangeDefaultFormatter::settingsSummary in core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeDefaultFormatter.php

Returns a short summary for the current formatter settings.

File

core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeDefaultFormatter.php, line 67

Class

DateTimeDefaultFormatter

Plugin implementation of the 'Default' formatter for 'datetime' fields.

Namespace

Drupal\datetime\Plugin\Field\FieldFormatter

Code

public function settingsSummary() {
  $summary = parent::settingsSummary();
  $date = new DrupalDateTime();
  $summary[] = t('Format: @display', [
    '@display' => $this
      ->formatDate($date),
  ]);
  return $summary;
}