Field Widget API
Same name in other branches
- 7.x modules/field/field.api.php \field_widget
- 9 core/modules/field/field.api.php \field_widget
- 8.9.x core/modules/field/field.api.php \field_widget
- 11.x core/modules/field/field.api.php \field_widget
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.
Widgets are Plugins managed by the \Drupal\Core\Field\WidgetPluginManager class. A widget is a plugin attributed with class \Drupal\Core\Field\Attribute\FieldWidget that implements \Drupal\Core\Field\WidgetInterface (in most cases, by subclassing \Drupal\Core\Field\WidgetBase). Widget plugins need to be in the namespace \Drupal\{your_module}\Plugin\Field\FieldWidget.
Widgets are Form API elements with additional processing capabilities. The methods of the WidgetInterface object are typically called by respective methods in the \Drupal\Core\Entity\Entity\EntityFormDisplay class.
See also
Parent topics
File
-
core/
modules/ field/ field.api.php, line 143
Functions
Title Sort descending | File name | Summary |
---|---|---|
hook_field_widget_complete_form_alter | core/ |
Alter the complete form for field widgets provided by other modules. |
hook_field_widget_complete_WIDGET_TYPE_form_alter | core/ |
Alter the complete form for a specific widget provided by other modules. |
hook_field_widget_info_alter | core/ |
Perform alterations on Field API widget types. |
hook_field_widget_single_element_form_alter | core/ |
Alter forms for field widgets provided by other modules. |
hook_field_widget_single_element_WIDGET_TYPE_form_alter | core/ |
Alter widget forms for a specific widget provided by another module. |
Classes
Title Sort descending | File name | Summary |
---|---|---|
FieldWidget | core/ |
Defines a FieldWidget attribute for plugin discovery. |
FieldWidget | core/ |
Defines a FieldWidget annotation object. |
WidgetBase | core/ |
Base class for 'Field widget' plugin implementations. |
WidgetPluginManager | core/ |
Plugin type manager for field widgets. |
Interfaces
Title Sort descending | File name | Summary |
---|---|---|
WidgetInterface | core/ |
Interface definition for field widget plugins. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.