Same name and namespace in other branches
  1. 8.9.x core/modules/field_ui/field_ui.api.php \hook_field_formatter_settings_summary_alter()
  2. 9 core/modules/field_ui/field_ui.api.php \hook_field_formatter_settings_summary_alter()

Alters the field formatter settings summary.

Parameters

array $summary: An array of summary messages.

array $context: An associative array with the following elements:

  • formatter: The formatter plugin.
  • field_definition: The field definition.
  • view_mode: The view mode being configured.

See also

\Drupal\field_ui\Form\EntityViewDisplayEditForm::alterSettingsSummary()

Related topics

Field Types API
Defines field, widget, display formatter, and storage types.
1 function implements hook_field_formatter_settings_summary_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

field_third_party_test_field_formatter_settings_summary_alter in core/modules/field/tests/modules/field_third_party_test/field_third_party_test.module
Implements hook_field_formatter_settings_summary_alter().

File

core/modules/field_ui/field_ui.api.php, line 92
Hooks provided by the Field UI module.

Code

function hook_field_formatter_settings_summary_alter(array &$summary, array $context) {

  // Append a message to the summary when an instance of foo_formatter has
  // my_setting set to TRUE for the current view mode.
  if ($context['formatter']
    ->getPluginId() == 'foo_formatter') {
    if ($context['formatter']
      ->getThirdPartySetting('my_module', 'my_setting')) {
      $summary[] = t('My setting enabled.');
    }
  }
}