function WidgetInterface::settingsSummary

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::settingsSummary()
  2. 10 core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::settingsSummary()
  3. 11.x core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::settingsSummary()

Returns a short summary for the current widget settings.

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

Return value

array A short summary of the widget settings.

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

File

core/lib/Drupal/Core/Field/WidgetInterface.php, line 46

Class

WidgetInterface
Interface definition for field widget 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.