function field_read_field

7.x field.crud.inc field_read_field($field_name, $include_additional = array())

Reads a single field record directly from the database.

Generally, you should use the field_info_field() instead.

This function will not return deleted fields. Use field_read_fields() instead for this purpose.

Parameters

$field_name: The field name to read.

array $include_additional: The default behavior of this function is to not return a field that is inactive. Setting $include_additional['include_inactive'] to TRUE will override this behavior.

Return value

A field definition array, or FALSE.

Related topics

15 calls to field_read_field()
FieldCrudTestCase::testDeleteField in drupal/modules/field/tests/field.test
Test the deletion of a field.
FieldCrudTestCase::testFieldIndexes in drupal/modules/field/tests/field.test
Test creation of indexes on data column.
FieldCrudTestCase::testReadField in drupal/modules/field/tests/field.test
Test reading back a field definition.
FieldCrudTestCase::_testActiveHelper in drupal/modules/field/tests/field.test
Helper function for testActive().
FieldInfo::getField in drupal/modules/field/field.info.class.inc
Returns a field definition from a field name.

... See full list

1 string reference to 'field_read_field'
field_read_fields in drupal/modules/field/field.crud.inc
Reads in fields that match an array of conditions.

File

drupal/modules/field/field.crud.inc, line 313
Field CRUD API, handling field and field instance creation and deletion.

Code

function field_read_field($field_name, $include_additional = array()) {
  $fields = field_read_fields(array('field_name' => $field_name), $include_additional);
  return $fields ? current($fields) : FALSE;
}