Documentation & API reference
Field CRUD API
Creates, updates, and deletes 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
- drupal/
core/ modules/ field/ field.crud.inc, line 13 - Field CRUD API, handling field and field instance creation and deletion.
Functions
Name |
Location | Description |
|---|---|---|
|
Field:: |
drupal/ |
Constructs a Field object. |
|
FieldInstance:: |
drupal/ |
Constructs a FieldInstance object. |
| field_create_field Deprecated |
drupal/ |
Creates a field. |
| field_create_instance Deprecated |
drupal/ |
Creates an instance of a field, binding it to a bundle. |
| field_delete_field Deprecated |
drupal/ |
Marks a field and its instances and data for deletion. |
| field_delete_instance Deprecated |
drupal/ |
Marks a field instance and its data for deletion. |
| field_read_field |
drupal/ |
Reads a single field record directly from the database. |
| field_read_fields |
drupal/ |
Reads in fields that match an array of conditions. |
| field_read_instance |
drupal/ |
Reads a single instance record from the database. |
| field_read_instances |
drupal/ |
Reads in field instances that match an array of conditions. |
| field_update_field Deprecated |
drupal/ |
Updates a field. |
| field_update_instance Deprecated |
drupal/ |
Updates an instance of a field. |
| hook_field_create_field |
drupal/ |
Act on a field being created. |
| hook_field_create_instance |
drupal/ |
Act on a field instance being created. |
| hook_field_delete_field |
drupal/ |
Act on a field being deleted. |
| hook_field_delete_instance |
drupal/ |
Act on a field instance being deleted. |
| hook_field_purge_field |
drupal/ |
Acts when a field record is being purged. |
| hook_field_purge_instance |
drupal/ |
Acts when a field instance is being purged. |
| hook_field_read_field |
drupal/ |
Act on field records being read from the database. |
| hook_field_read_instance |
drupal/ |
Act on a field record being read from the database. |
| hook_field_storage_purge |
drupal/ |
Remove field storage information when field data is purged. |
| hook_field_storage_purge_field |
drupal/ |
Remove field storage information when a field record is purged. |
| hook_field_storage_purge_field_instance |
drupal/ |
Remove field storage information when a field instance is purged. |
| hook_field_update_field |
drupal/ |
Act on a field being updated. |
| hook_field_update_forbid |
drupal/ |
Forbid a field update from occurring. |
| hook_field_update_instance |
drupal/ |
Act on a field instance being updated. |