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 object. 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
@see hook_field_info_alter().
See also
@see hook_field_load().
See also
@see hook_field_presave().
See also
@see hook_field_update().
See also
@see hook_field_delete_revision().
See also
@see hook_field_is_empty().
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 objects. Widgets and formatters can be implemented by a field-type module for it's own field types, or by a third-party module to extend the behavior of existing field types.
See also
@see hook_field_formatter_info().
A third kind of pluggable handlers, storage backends, is defined by the Field Storage API.
Functions
| Name | Location | Description |
|---|---|---|
| hook_field_delete | modules/field/field.api.php | Define custom delete behavior for this module's field types. |
| hook_field_delete_revision | modules/field/field.api.php | Define custom delete_revision behavior for this module's field types. |
| 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 multiple objects. |
| hook_field_info | modules/field/field.api.php | Define Field API field types. |
| hook_field_info_alter | modules/field/field.api.php | Perform alterations on Field API field types. |
| hook_field_insert | modules/field/field.api.php | Define custom insert behavior for this module's field types. |
| hook_field_is_empty | modules/field/field.api.php | Define what constitutes an empty item for a field type. |
| hook_field_load | modules/field/field.api.php | Define custom load behavior for this module's field types. |
| hook_field_prepare_translation | modules/field/field.api.php | Define custom prepare_translation behavior for this module's field types. |
| hook_field_presave | modules/field/field.api.php | Define custom presave behavior for this module's field types. |
| hook_field_sanitize | modules/field/field.api.php | Define custom sanitize behavior for this module's field types. |
| hook_field_schema | modules/field/field.api.php | Define the Field API schema for a field structure. |
| hook_field_update | modules/field/field.api.php | Define custom update behavior for this module's field types. |
| hook_field_validate | modules/field/field.api.php | Define custom validate behavior for this module's field types. |
| hook_field_widget | modules/field/field.api.php | Return a single form element for a field widget. |
| hook_field_widget_error | modules/field/field.api.php | Flag a field-level validation error. |
| hook_field_widget_info | modules/field/field.api.php | Expose Field API widget types. |
| hook_field_widget_info_alter | modules/field/field.api.php | Perform alterations on Field API widget types. |
| theme_field_formatter_FORMATTER_MULTIPLE | modules/field/field.api.php | Theme function for a field formatter. |
| theme_field_formatter_FORMATTER_SINGLE | modules/field/field.api.php | Theme function for a field formatter. |