1 field_ui.api.php hook_field_formatter_settings_summary($field, $instance, $view_mode)

Return a short summary for the current formatter settings of an instance.

If an empty result is returned, the formatter is assumed to have no configurable settings, and no UI will be provided to display a settings form.


$field: The field structure.

$instance: The instance structure.

$view_mode: The Display mode for which a settings summary is requested.

Return value

A string containing a short summary of the formatter settings.:

Related topics


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


function hook_field_formatter_settings_summary($field, $instance, $view_mode) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];

  $summary = '';

  if ($display['type'] == 'text_trimmed' || $display['type'] == 'text_summary_or_trimmed') {
    $summary = t('Length: @chars chars', array('@chars' => $settings['trim_length']));

  return $summary;