field_read_fields

Versions
7: field_read_fields($params = array(), $include_additional = array())

Read in fields that match an array of conditions.

Parameters

array $params An array of conditions to match against.

array $include_additional The default behavior of this function is to not return fields that are inactive or have been deleted. Setting $include_additional['include_inactive'] or $include_additional['include_deleted'] to TRUE will override this behavior.

Return value

An array of fields matching $params. If $include_additional['include_deletd'] is TRUE, the array is keyed by field id, otherwise it is keyed by field name.

▸ 6 functions call field_read_fields()

▾ 6 functions call field_read_fields()

field_purge_batch in modules/field/field.crud.inc: Purge some deleted Field API data, instances, or fields.
field_read_field in modules/field/field.crud.inc: Read a single field record directly from the database. Generally, you should use the field_info_field() instead.
field_sql_storage_schema in modules/field/modules/field_sql_storage/field_sql_storage.install: Implement hook_schema().
_field_info_collate_fields in modules/field/field.info.inc: Collate all information on existing fields and instances.
_field_ui_field_overview_form_validate_add_new in modules/field_ui/field_ui.admin.inc: Helper function for field_ui_field_overview_form_validate.
_taxonomy_clean_field_cache in modules/taxonomy/taxonomy.module: Helper function that clears field cache when terms are updated or deleted

Code

modules/field/field.crud.inc, line 486

<?php
function field_read_fields($params = array(), $include_additional = array()) {
  $query = db_select('field_config', 'fc', array('fetch' => PDO::FETCH_ASSOC));
  $query->fields('fc');

  // Turn the conditions into a query.
  foreach ($params as $key => $value) {
    $query->condition($key, $value);
  }
  if (!isset($include_additional['include_inactive']) || !$include_additional['include_inactive']) {
    $query
      ->condition('fc.active', 1)
      ->condition('fc.storage_active', 1);
  }
  $include_deleted = (isset($include_additional['include_deleted']) && $include_additional['include_deleted']);
  if (!$include_deleted) {
    $query->condition('fc.deleted', 0);
  }

  $fields = array();
  $results = $query->execute();
  foreach ($results as $record) {
    $field = unserialize($record['data']);
    $field['id'] = $record['id'];
    $field['field_name'] = $record['field_name'];
    $field['type'] = $record['type'];
    $field['module'] = $record['module'];
    $field['active'] = $record['active'];
    $field['storage']['type'] = $record['storage_type'];
    $field['storage']['module'] = $record['storage_module'];
    $field['storage']['active'] = $record['storage_active'];
    $field['locked'] = $record['locked'];
    $field['cardinality'] = $record['cardinality'];
    $field['translatable'] = $record['translatable'];
    $field['deleted'] = $record['deleted'];

    module_invoke_all('field_read_field', $field);

    // Populate storage information.
    $schema = (array) module_invoke($field['module'], 'field_schema', $field);
    $schema += array('columns' => array(), 'indexes' => array());
    $field['columns'] = $schema['columns'];

    $field_name = $field['field_name'];
    if ($include_deleted) {
      $field_name = $field['id'];
    }
    $fields[$field_name] = $field;
  }
  return $fields;
}
?>