function hook_field_widget_settings_summary_alter

Alters the field widget settings summary.

Parameters

array $summary: An array of summary messages.

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

• widget: The widget object.
• field_definition: The field definition.
• form_mode: The form mode being configured.

See also

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

Related topics

File

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

Code

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