field.module

Attach custom data fields to Drupal entities.

File

modules/field/field.module

Functions

Name Description
field_access Determine whether the user has access to a given field.
field_associate_fields Allows a module to update the database for fields and columns it controls.
field_bundle_settings Gets or sets administratively defined bundle settings.
field_cache_clear Clear the field info and field data caches.
field_cron Implements hook_cron().
field_extract_bundle Helper function to extract the bundle name of from a bundle object.
field_extra_fields_get_display Returns the display settings to use for pseudo-fields in a given view mode.
field_filter_xss Like filter_xss_admin(), but with a shorter list of allowed tags.
field_flush_caches Implements hook_flush_caches().
field_get_default_value Helper function to get the default value for a field on an entity.
field_get_display Returns the display settings to use for an instance in a given view mode.
field_get_items Returns the field items in the language they currently would be displayed.
field_has_data Determine whether a field has any data.
field_help Implements hook_help().
field_modules_disabled Implements hook_modules_disabled().
field_modules_enabled Implements hook_modules_enabled().
field_permission Implements hook_permission().
field_sync_field_status Refreshes the 'active' and 'storage_active' columns for fields.
field_system_info_alter Implements hook_system_info_alter().
field_theme Implements hook_theme().
field_view_field Returns a renderable array for the value of a single field in an entity.
field_view_mode_settings Returns view mode settings in a given bundle.
field_view_value Returns a renderable array for a single field value.
template_preprocess_field Theme preprocess function for theme_field() and field.tpl.php.
template_process_field Theme process function for theme_field() and field.tpl.php.
theme_field Returns HTML for a field.
_element_validate_integer DEPRECATED: Helper form element validator: integer.
_element_validate_integer_positive DEPRECATED: Helper form element validator: integer > 0.
_element_validate_number DEPRECATED: Helper form element validator: number.
_field_extra_fields_pre_render Pre-render callback to adjust weights and visibility of non-field elements.
_field_filter_items Helper function to filter out empty field values.
_field_filter_xss_allowed_tags List of tags allowed by field_filter_xss().
_field_filter_xss_display_allowed_tags Human-readable list of allowed tags, for display in help texts.
_field_sort_items Helper function to sort items in a field according to user drag-n-drop reordering.
_field_sort_items_helper Sort function for items order. (copied form element_sort(), which acts on #weight keys)
_field_sort_items_value_helper Same as above, using ['_weight']['#value']

Constants

Name Description
FIELD_BEHAVIOR_CUSTOM Value for field API indicating a widget can receive several field values.
FIELD_BEHAVIOR_DEFAULT Value for field API concerning widget default and multiple value settings.
FIELD_BEHAVIOR_NONE Value for field API indicating a widget doesn't accept default values.
FIELD_CARDINALITY_UNLIMITED Value for field API indicating a field accepts an unlimited number of values.
FIELD_LOAD_CURRENT Age argument for loading the most recent version of an entity's field data with field_attach_load().
FIELD_LOAD_REVISION Age argument for loading the version of an entity's field data specified in the entity with field_attach_load().

Classes

Name Description
FieldException Base class for all exceptions thrown by Field API functions.
FieldUpdateForbiddenException Exception class thrown by hook_field_update_forbid().

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/modules!field!field.module/7.x