Field Formatter API

Same name in other branches
  1. 9 core/modules/field/field.api.php \field_formatter
  2. 8.9.x core/modules/field/field.api.php \field_formatter
  3. 10 core/modules/field/field.api.php \field_formatter
  4. 11.x core/modules/field/field.api.php \field_formatter

Define Field API formatter types.

Field API formatters specify how fields are displayed when the entity to which the field is attached is displayed. Fields of a given field type may be displayed using more than one formatter. In this case, the Field UI module allows the site builder to choose which formatter to use. Field formatters are defined by implementing hook_field_formatter_info().

See also

Field API

Field Types API

Field Widget API

Parent topics

Hooks
Allow modules to interact with the Drupal core.

File

modules/field/field.api.php, line 1024

Functions

Title File name Summary
hook_field_formatter_info modules/field/field.api.php Expose Field API formatter types.
hook_field_formatter_info_alter modules/field/field.api.php Perform alterations on Field API formatter types.
hook_field_formatter_prepare_view modules/field/field.api.php Allow formatters to load information for field values being displayed.
hook_field_formatter_view modules/field/field.api.php Build a renderable array for a field value.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.