1.20.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

Field CRUD API Create, update, and delete Field API fields, bundles, and instances.

File

modules/field/field.crud.inc, line 309
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 isset($fields[$field_name]) ? $fields[$field_name] : FALSE;
}