You are here

Home » API reference » Drupal 10 » FormatterBase.php » FormatterBase

public function FormatterBase::settingsSummary in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Field/FormatterBase.php \Drupal\Core\Field\FormatterBase::settingsSummary()
  2. 9 core/lib/Drupal/Core/Field/FormatterBase.php \Drupal\Core\Field\FormatterBase::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 FormatterInterface::settingsSummary

4 calls to FormatterBase::settingsSummary()
DescriptionAwareFileFormatterBase::settingsSummary in core/modules/file/src/Plugin/Field/FieldFormatter/DescriptionAwareFileFormatterBase.php
Returns a short summary for the current formatter settings.
ImageFormatter::settingsSummary in core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php
Returns a short summary for the current formatter settings.
TimestampAgoFormatter::settingsSummary in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/TimestampAgoFormatter.php
Returns a short summary for the current formatter settings.
TimestampFormatter::settingsSummary in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/TimestampFormatter.php
Returns a short summary for the current formatter settings.
22 methods override FormatterBase::settingsSummary()
BooleanFormatter::settingsSummary in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php
Returns a short summary for the current formatter settings.
CommentDefaultFormatter::settingsSummary in core/modules/comment/src/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php
Returns a short summary for the current formatter settings.
DateTimeFormatterBase::settingsSummary in core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php
Returns a short summary for the current formatter settings.
DescriptionAwareFileFormatterBase::settingsSummary in core/modules/file/src/Plugin/Field/FieldFormatter/DescriptionAwareFileFormatterBase.php
Returns a short summary for the current formatter settings.
DummyAjaxFormatter::settingsSummary in core/modules/image/tests/modules/image_module_test/src/Plugin/Field/FieldFormatter/DummyAjaxFormatter.php
Returns a short summary for the current formatter settings.

... See full list

File

core/lib/Drupal/Core/Field/FormatterBase.php, line 131

Class

FormatterBase
Base class for 'Field formatter' plugin implementations.

Namespace

Drupal\Core\Field

Code

public function settingsSummary() {
  return [];
}