You are here

Home » API reference » Zircon Profile 8 » FormatterBase.php » FormatterBase

public function FormatterBase::settingsSummary in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 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()
DateTimeFormatterBase::settingsSummary in core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php
Returns a short summary for the current formatter settings.
DateTimeTimeAgoFormatter::settingsSummary in core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeTimeAgoFormatter.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.
18 methods override FormatterBase::settingsSummary()
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.
DateTimeTimeAgoFormatter::settingsSummary in core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeTimeAgoFormatter.php
Returns a short summary for the current formatter settings.
EntityReferenceEntityFormatter::settingsSummary in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceEntityFormatter.php
Returns a short summary for the current formatter settings.
EntityReferenceLabelFormatter::settingsSummary in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php
Returns a short summary for the current formatter settings.

... See full list

File

core/lib/Drupal/Core/Field/FormatterBase.php, line 126
Contains \Drupal\Core\Field\FormatterBase.

Class

FormatterBase
Base class for 'Field formatter' plugin implementations.

Namespace

Drupal\Core\Field

Code

public function settingsSummary() {
  return array();
}