/Drupal 8

Field Formatter API

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.

Formatters are Plugins managed by the \Drupal\Core\Field\FormatterPluginManager class. A formatter is a plugin annotated with class \Drupal\Core\Field\Annotation\FieldFormatter that implements \Drupal\Core\Field\FormatterInterface (in most cases, by subclassing \Drupal\Core\Field\FormatterBase). Formatter plugins need to be in the namespace \Drupal\{your_module}\Plugin\Field\FieldFormatter.

See also

Field API

Field Types API

Field Widget API

Plugin API

Parent topics

Define functions that alter the behavior of Drupal core.


core/modules/field/field.api.php, line 197
Field API documentation.


Name Location Description
hook_field_formatter_info_alter core/modules/field/field.api.php Perform alterations on Field API formatter types.


Name Location Description
FieldFormatter core/lib/Drupal/Core/Field/Annotation/FieldFormatter.php Defines a FieldFormatter annotation object.
FormatterBase core/lib/Drupal/Core/Field/FormatterBase.php Base class for 'Field formatter' plugin implementations.
FormatterPluginManager core/lib/Drupal/Core/Field/FormatterPluginManager.php Plugin type manager for field formatters.


Name Location Description
FormatterInterface core/lib/Drupal/Core/Field/FormatterInterface.php Interface definition for field formatter plugins.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.