Create, update, and delete Field API fields, bundles, and instances.
Modules use this API, often in hook_install(), to create custom data structures. UI modules will use it to create a user interface.
The Field CRUD API uses Field API data structures.
See Field API for information about the other parts of the Field API.
Functions & methods
| Name | Description |
|---|---|
| field_create_field | Creates a field. |
| field_create_instance | Creates an instance of a field, binding it to a bundle. |
| field_delete_field | Marks a field and its instances and data for deletion. |
| field_delete_instance | Marks a field instance and its data for deletion. |
| field_read_field | Reads a single field record directly from the database. |
| field_read_fields | Reads in fields that match an array of conditions. |
| field_read_instance | Reads a single instance record from the database. |
| field_read_instances | Reads in field instances that match an array of conditions. |
| field_update_field | Updates a field. |
| field_update_instance | Updates an instance of a field. |
| hook_field_create_field | Act on a field being created. |
| hook_field_create_instance | Act on a field instance being created. |
| hook_field_delete_field | Act on a field being deleted. |
| hook_field_delete_instance | Act on a field instance being deleted. |
| hook_field_purge_field | Acts when a field record is being purged. |
| hook_field_purge_instance | Acts when a field instance is being purged. |
| hook_field_read_field | Act on field records being read from the database. |
| hook_field_read_instance | Act on a field record being read from the database. |
| hook_field_storage_purge | Remove field storage information when field data is purged. |
| hook_field_storage_purge_field | Remove field storage information when a field record is purged. |
| hook_field_storage_purge_field_instance | Remove field storage information when a field instance is purged. |
| hook_field_update_field | Act on a field being updated. |
| hook_field_update_forbid | Forbid a field update from occurring. |
| hook_field_update_instance | Act on a field instance being updated. |
| _field_write_instance | Stores an instance record in the field configuration database. |
File
- core/
modules/ field/ field.crud.inc, line 10 - Field CRUD API, handling field and field instance creation and deletion.