Field Types API

Define field types.

In the Field API, each field has a type, which determines what kind of data (integer, string, date, etc.) the field can hold, which settings it provides, and so on. The data type(s) accepted by a field are defined in hook_field_schema(); other basic properties of a field are defined in hook_field_info(). The other hooks below are called by the Field Attach API to perform field-type-specific actions.

The Field Types API also defines two kinds of pluggable handlers: widgets and formatters. Widgets specify how the field appears in edit forms, while formatters specify how the field appears in displayed entities.

A third kind of pluggable handlers, storage backends, is defined by the Field Storage API.

See Field API for information about the other parts of the Field API.

Parent topics

File

drupal/modules/field/field.api.php, line 97

Hooks provided by the Field module.

Functions

Name	Location	Description
hook_field_widget_settings_form	drupal/modules/field_ui/field_ui.api.php	Add settings to a widget settings form.
hook_field_validate	drupal/modules/field/field.api.php	Validate this module's field data.
hook_field_update	drupal/modules/field/field.api.php	Define custom update behavior for this module's field data.
hook_field_storage_update_field	drupal/modules/field/field.api.php	Update the storage information for a field.
hook_field_settings_form	drupal/modules/field_ui/field_ui.api.php	Add settings to a field settings form.
hook_field_schema	drupal/modules/field/field.api.php	Define the Field API schema for a field structure.
hook_field_presave	drupal/modules/field/field.api.php	Define custom presave behavior for this module's field types.
hook_field_prepare_view	drupal/modules/field/field.api.php	Prepare field values prior to display.
hook_field_prepare_translation	drupal/modules/field/field.api.php	Define custom prepare_translation behavior for this module's field types.
hook_field_load	drupal/modules/field/field.api.php	Define custom load behavior for this module's field types.
hook_field_is_empty	drupal/modules/field/field.api.php	Define what constitutes an empty item for a field type.
hook_field_instance_settings_form	drupal/modules/field_ui/field_ui.api.php	Add settings to an instance field settings form.
hook_field_insert	drupal/modules/field/field.api.php	Define custom insert behavior for this module's field data.
hook_field_info_alter	drupal/modules/field/field.api.php	Perform alterations on Field API field types.
hook_field_info	drupal/modules/field/field.api.php	Define Field API field types.
hook_field_formatter_settings_summary	drupal/modules/field_ui/field_ui.api.php	Return a short summary for the current formatter settings of an instance.
hook_field_formatter_settings_form	drupal/modules/field_ui/field_ui.api.php	Specify the form elements for a formatter's settings.
hook_field_extra_fields_display_alter	drupal/modules/field/field.api.php	Alters the display settings of pseudo-fields before an entity is displayed.
hook_field_extra_fields_alter	drupal/modules/field/field.api.php	Alter "pseudo-field" components on fieldable entities.
hook_field_extra_fields	drupal/modules/field/field.api.php	Exposes "pseudo-field" components on fieldable entities.
hook_field_display_ENTITY_TYPE_alter	drupal/modules/field/field.api.php	Alters the display settings of a field on a given entity type before it gets displayed.
hook_field_display_alter	drupal/modules/field/field.api.php	Alters the display settings of a field before it gets displayed.
hook_field_delete_revision	drupal/modules/field/field.api.php	Define custom revision delete behavior for this module's field types.
hook_field_delete	drupal/modules/field/field.api.php	Define custom delete behavior for this module's field data.
hook_field_access	drupal/modules/field/field.api.php	Determine whether the user has access to a given field.