function FormatterInterface::settingsSummary

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::settingsSummary()
  2. 10 core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::settingsSummary()
  3. 11.x core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::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.

1 method overrides FormatterInterface::settingsSummary()
FormatterBase::settingsSummary in core/lib/Drupal/Core/Field/FormatterBase.php
Returns a short summary for the current formatter settings.

File

core/lib/Drupal/Core/Field/FormatterInterface.php, line 40

Class

FormatterInterface
Interface definition for field formatter plugins.

Namespace

Drupal\Core\Field

Code

public function settingsSummary();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.