Field Types API
Define field types, widget types, display formatter types, storage types.
The bulk of the Field Types API are related to field types. A field type represents a particular type of data (integer, string, date, etc.) that can be attached to a fieldable entity. hook_field_info() defines the basic properties of a field type, and a variety of other field hooks are called by the Field Attach API to perform field-type-specific actions.
See also
The Field Types API also defines two kinds of pluggable handlers: widgets and formatters, which specify how the field appears in edit forms and in displayed entities. Widgets and formatters can be implemented by a field-type module for its own field types, or by a third-party module to extend the behavior of existing field types.
A third kind of pluggable handlers, storage backends, is defined by the
Functions & methods
| Name | Description |
|---|---|
| hook_field_delete | Define custom delete behavior for this module's field types. |
| hook_field_delete_revision | Define custom revision delete behavior for this module's field types. |
| hook_field_formatter_info | Expose Field API formatter types. |
| hook_field_formatter_info_alter | Perform alterations on Field API formatter types. |
| hook_field_formatter_prepare_view | Allow formatters to load information for field values being displayed. |
| hook_field_formatter_view | Build a renderable array for a field value. |
| hook_field_info | Define Field API field types. |
| hook_field_info_alter | Perform alterations on Field API field types. |
| hook_field_insert | Define custom insert behavior for this module's field types. |
| hook_field_is_empty | Define what constitutes an empty item for a field type. |
| hook_field_load | Define custom load behavior for this module's field types. |
| hook_field_prepare_translation | Define custom prepare_translation behavior for this module's field types. |
| hook_field_prepare_view | Prepare field values prior to display. |
| hook_field_presave | Define custom presave behavior for this module's field types. |
| hook_field_schema | Define the Field API schema for a field structure. |
| hook_field_storage_update_field | Update the storage information for a field. |
| hook_field_update | Define custom update behavior for this module's field types. |
| hook_field_validate | Validate this module's field data. |
| hook_field_widget_error | Flag a field-level validation error. |
| hook_field_widget_form | Return the form for a single field widget. |
| hook_field_widget_info | Expose Field API widget types. |
| hook_field_widget_info_alter | Perform alterations on Field API widget types. |
drupal/
