Field CRUD API
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.
File
-
modules/
field/ field.crud.inc, line 8
Functions
| Title Sort descending | File name | Summary |
|---|---|---|
| field_create_field | modules/ |
Creates a field. |
| field_create_instance | modules/ |
Creates an instance of a field, binding it to a bundle. |
| field_delete_field | modules/ |
Marks a field and its instances and data for deletion. |
| field_delete_instance | modules/ |
Marks a field instance and its data for deletion. |
| field_read_field | modules/ |
Reads a single field record directly from the database. |
| field_read_fields | modules/ |
Reads in fields that match an array of conditions. |
| field_read_instance | modules/ |
Reads a single instance record from the database. |
| field_read_instances | modules/ |
Reads in field instances that match an array of conditions. |
| field_update_field | modules/ |
Updates a field. |
| field_update_instance | modules/ |
Updates an instance of a field. |
| hook_field_create_field | modules/ |
Act on a field being created. |
| hook_field_create_instance | modules/ |
Act on a field instance being created. |
| hook_field_delete_field | modules/ |
Act on a field being deleted. |
| hook_field_delete_instance | modules/ |
Act on a field instance being deleted. |
| hook_field_purge_field | modules/ |
Acts when a field record is being purged. |
| hook_field_purge_instance | modules/ |
Acts when a field instance is being purged. |
| hook_field_read_field | modules/ |
Act on field records being read from the database. |
| hook_field_read_instance | modules/ |
Act on a field record being read from the database. |
| hook_field_storage_purge | modules/ |
Remove field storage information when field data is purged. |
| hook_field_storage_purge_field | modules/ |
Remove field storage information when a field record is purged. |
| hook_field_storage_purge_field_instance | modules/ |
Remove field storage information when a field instance is purged. |
| hook_field_update_field | modules/ |
Act on a field being updated. |
| hook_field_update_forbid | modules/ |
Forbid a field update from occurring. |
| hook_field_update_instance | modules/ |
Act on a field instance being updated. |
| _field_write_instance | modules/ |
Stores an instance record in the field configuration database. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.