Field Info API

  1. drupal
    1. 8
    2. 7

Obtain information about Field API configuration.

The Field Info API exposes information about field types, fields, instances, bundles, widget types, display formatters, behaviors, and settings defined by or with the Field API.

Functions & methods

NameDescription
field_behaviors_widgetDetermines the behavior of a widget with respect to an operation.
field_info_bundlesReturns information about existing bundles.
field_info_cache_clearClears the field info cache without clearing the field data cache.
field_info_extra_fieldsReturns a list and settings of pseudo-field elements in a given bundle.
field_info_fieldReturns data about an individual field, given a field name.
field_info_fieldsReturns all field definitions.
field_info_field_by_idReturns data about an individual field, given a field ID.
field_info_field_by_idsReturns the same data as field_info_field_by_id() for every field.
field_info_field_settingsReturns a field type's default settings.
field_info_field_typesReturns information about field types from hook_field_info().
field_info_formatter_settingsReturns a field formatter's default settings.
field_info_formatter_typesReturns information about field formatters from hook_field_formatter_info().
field_info_instanceReturns an array of instance data for a specific field and bundle.
field_info_instancesRetrieves information about field instances.
field_info_instance_settingsReturns a field type's default instance settings.
field_info_max_weightReturns the maximum weight of all the components in an entity.
field_info_storage_settingsReturns a field storage type's default settings.
field_info_storage_typesReturns information about field storage from hook_field_storage_info().
field_info_widget_settingsReturns a field widget's default settings.
field_info_widget_typesReturns information about field widgets from hook_field_widget_info().
_field_info_collate_fieldsCollates all information on existing fields and instances.
_field_info_collate_typesCollates all information on field types, widget types and related structures.
_field_info_prepare_extra_fieldsPrepares 'extra fields' for the current run-time context.
_field_info_prepare_fieldPrepares a field definition for the current run-time context.
_field_info_prepare_instancePrepares an instance definition for the current run-time context.
_field_info_prepare_instance_displayAdapts display specifications to the current run-time context.
_field_info_prepare_instance_widgetPrepares widget specifications for the current run-time context.

modules/field/field.info.inc, line 8