function 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

File

core/modules/field_ui/field_ui.api.php, line 92

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
    // mysetting 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.');
        }
    }
}