function hook_field_formatter_settings_summary

7.x 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.

Parameters

$field: The field structure.

$instance: The instance structure.

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

Return value

A string containing a short summary of the formatter settings.

Related topics

Field Types API: Define field types.

4 functions implement hook_field_formatter_settings_summary()

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

field_test_field_formatter_settings_summary in drupal-7.x/modules/field/tests/field_test.field.inc: Implements hook_field_formatter_settings_summary().
image_field_formatter_settings_summary in drupal-7.x/modules/image/image.field.inc: Implements hook_field_formatter_settings_summary().
number_field_formatter_settings_summary in drupal-7.x/modules/field/modules/number/number.module: Implements hook_field_formatter_settings_summary().
text_field_formatter_settings_summary in drupal-7.x/modules/field/modules/text/text.module: Implements hook_field_formatter_settings_summary().

1 invocation of hook_field_formatter_settings_summary()

field_ui_display_overview_form in drupal-7.x/modules/field_ui/field_ui.admin.inc: Form constructor for the field display settings for a given view mode.

File

drupal-7.x/modules/field_ui/field_ui.api.php, line 189: Hooks provided by the Field UI module.

Code

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;
}