public function TripalFieldFormatter::settingsSummary
| 3.x TripalFieldFormatter.inc | public TripalFieldFormatter::settingsSummary($view_mode) |
Provides a summary of the formatter settings.
This function corresponds to the hook_field_formatter_settings_summary() function of the Drupal Field API.
On the 'Manage Display' page of the content type administration page, fields are allowed to provide a settings form. This settings form can be used to allow the site admin to define how the field should be formatted. The settings are then available for the formatter() function of this class. This function provides a text-based description of the settings for the site developer to see. It appears on the manage display page inline with the field. A field must always return a value in this function if the settings form gear button is to appear.
See the hook_field_formatter_settings_summary() function for more information.
Parameters
$field:
$instance:
$view_mode:
Return value
string A string that provides a very brief summary of the field settings to the user.
- remote__data_formatter::settingsSummary in tripal_ws/
includes/ TripalFields/ remote__data/ remote__data_formatter.inc - Provides a summary of the formatter settings.
- sbo__relationship_formatter::settingsSummary in tripal_chado/
includes/ TripalFields/ sbo__relationship/ sbo__relationship_formatter.inc - sep__protocol_formatter::settingsSummary in tripal_chado/
includes/ TripalFields/ sep__protocol/ sep__protocol_formatter.inc - Provides a summary of the formatter settings.
File
- tripal/
includes/ TripalFields/ TripalFieldFormatter.inc, line 165
Class
Code
public function settingsSummary($view_mode) {
}