Define Field API widget types.

Field API widgets specify how fields are displayed in edit forms. Fields of a given field type may be edited using more than one widget. In this case, the Field UI module allows the site builder to choose which widget to use. Widget types are defined by implementing hook_field_widget_info().

Widgets are Form API elements with additional processing capabilities. Widget hooks are typically called by the Field Attach API during the creation of the field form structure with field_attach_form().

See also

Field API

Field Types API

Field Formatter API

Parent topics


core/modules/field/field.api.php, line 688
Hooks provided by the Field module.


Name Locationsort descending Description
hook_field_widget_info core/modules/field/field.api.php Expose Field API widget types.
hook_field_widget_info_alter core/modules/field/field.api.php Perform alterations on Field API widget types.
hook_field_widget_form core/modules/field/field.api.php Return the form for a single field widget.
hook_field_widget_form_alter core/modules/field/field.api.php Alter forms for field widgets provided by other modules.
hook_field_widget_WIDGET_TYPE_form_alter core/modules/field/field.api.php Alter widget forms for a specific widget provided by another module.
hook_field_widget_properties_alter core/modules/field/field.api.php Alters the widget properties of a field instance before it gets displayed.
hook_field_widget_error core/modules/field/field.api.php Flag a field-level validation error.
hook_field_widget_properties_ENTITY_TYPE_alter core/modules/field/field.api.php Alters the widget properties of a field instance on a given entity type before it gets displayed.
hook_field_widget_settings_form core/modules/field_ui/field_ui.api.php Add settings to a widget settings form.