field.module 35.4 KB
Newer Older
1 2 3 4
<?php
// $Id$
/**
 * @file
5
 * Attach custom data fields to Drupal entities.
6 7
 */

8 9 10 11 12 13 14 15
/**
 * Base class for all exceptions thrown by Field API functions.
 *
 * This class has no functionality of its own other than allowing all
 * Field API exceptions to be caught by a single catch block.
 */
class FieldException extends Exception {}

16
/*
17 18 19
 * Load all public Field API functions. Drupal currently has no
 * mechanism for auto-loading core APIs, so we have to load them on
 * every page request.
20
 */
21 22 23 24 25 26
require_once DRUPAL_ROOT . '/modules/field/field.crud.inc';
require_once DRUPAL_ROOT . '/modules/field/field.default.inc';
require_once DRUPAL_ROOT . '/modules/field/field.info.inc';
require_once DRUPAL_ROOT . '/modules/field/field.multilingual.inc';
require_once DRUPAL_ROOT . '/modules/field/field.attach.inc';
require_once DRUPAL_ROOT . '/modules/field/field.form.inc';
27

28 29 30
/**
 * @defgroup field Field API
 * @{
31
 * Attach custom data fields to Drupal entities.
32 33
 *
 * The Field API allows custom data fields to be attached to Drupal
34 35
 * entities and takes care of storing, loading, editing, and rendering
 * field data. Any entity type (node, user, etc.) can use the Field
36
 * API to make itself "fieldable" and thus allow fields to be attached
37
 * to it. Other modules can provide a user interface for managing custom
38
 * fields via a web browser as well as a wide and flexible variety of
39 40 41 42
 * data type, form element, and display format capabilities.
 *
 * - @link field_structs Data structures: Field, Instance, Bundle @endlink.
 *
43 44
 * - @link field_types Field Types API @endlink. Defines field types,
 *   widget types, and display formatters. Field modules use this API
45 46 47
 *   to provide field types like Text and Node Reference along with the
 *   associated form elements and display formatters.
 *
48
 * - @link field_crud Field CRUD API @endlink. Create, updates, and
49 50
 *   deletes fields, bundles (a.k.a. "content types"), and instances.
 *   Modules use this API, often in hook_install(), to create
51
 *   custom data structures.
52
 *
53
 * - @link field_attach Field Attach API @endlink. Connects entity
54
 *   types to the Field API. Field Attach API functions load, store,
55
 *   generate Form API structures, display, and perform a variety of
56 57
 *   other functions for field data connected to individual entities.
 *   Fieldable entity types like node and user use this API to make
58 59
 *   themselves fieldable.
 *
60
 * - @link field_info Field Info API @endlink. Exposes information
61 62 63
 *   about all fields, instances, widgets, and related information
 *   defined by or with the Field API.
 *
64 65
 * - @link field_storage Field Storage API @endlink. Provides a
 *   pluggable back-end storage system for actual field data. The
66 67
 *   default implementation, field_sql_storage.module, stores field data
 *   in the local SQL database.
68
 *
69 70 71
 * - @link field_purge Field API bulk data deletion @endlink. Cleans
 *   up after bulk deletion operations such as field_delete_field()
 *   and field_delete_instance().
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
 */

/**
 * Value for $field['cardinality'] property to indicate it can hold an
 * unlimited number of values.
 */
define('FIELD_CARDINALITY_UNLIMITED', -1);

/**
 * TODO
 */
define('FIELD_BEHAVIOR_NONE', 0x0001);
/**
 * TODO
 */
define('FIELD_BEHAVIOR_DEFAULT', 0x0002);
/**
 * TODO
 */
define('FIELD_BEHAVIOR_CUSTOM', 0x0004);

/**
94
 * Age argument for loading the most recent version of an entity's
95 96 97 98
 * field data with field_attach_load().
 */
define('FIELD_LOAD_CURRENT', 'FIELD_LOAD_CURRENT');
/**
99 100
 * Age argument for loading the version of an entity's field data
 * specified in the entity with field_attach_load().
101 102 103
 */
define('FIELD_LOAD_REVISION', 'FIELD_LOAD_REVISION');

104 105 106 107 108
/**
 * Exception class thrown by hook_field_update_forbid().
 */
class FieldUpdateForbiddenException extends FieldException {}

109
/**
110
 * Implements hook_flush_caches().
111 112 113 114 115 116
 */
function field_flush_caches() {
  return array('cache_field');
}

/**
117
 * Implements hook_help().
118 119 120 121
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
122 123
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
124
      $output .= '<p>' . t('The Field module allows custom data fields to be attached to Drupal <em>entities</em> (content nodes, users, taxonomy vocabularies, etc.) and takes care of storing, loading, editing, and rendering field data. Most users will not interact with the Field module directly, but will instead use the <a href="@field-ui-help">Field UI module</a> user interface. Module developers can use the Field API to make new entities "fieldable" and thus allow fields to be attached to their entities. For more information, see the online handbook entry for <a href="@field">Field module</a>.', array('@field-ui-help' => url('admin/help/field_ui'), '@field' => 'http://drupal.org/handbook/modules/field')) . '</p>';
125 126 127
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
128
      $output .= '<dd>' . t('The Field module provides the infrastructure for fields and field attachment; the field types and input widgets themselves are provided by additional modules. Some of the modules are required; the optional modules can be enabled from the <a href="@modules">Modules administration page</a>. Drupal core includes the following field type modules: Number (required), Text (required), List (required), Taxonomy (optional), Image (optional), and File (optional); the required Options module provides input widgets for other field modules. Additional fields and widgets may be provided by contributed modules, which you can find in the <a href="@contrib">contributed module section of Drupal.org</a>. Currently enabled field and input widget modules:', array('@modules' => url('admin/modules'), '@contrib' => 'http://drupal.org/project/modules', '@options' => url('admin/help/options')));
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

      // Make a list of all widget and field modules currently enabled, in
      // order by displayed module name (module names are not translated).
      $items = array();
      $info = system_get_info('module');
      $modules = array_merge(module_implements('field_info'), module_implements('field_widget_info'));
      $modules = array_unique($modules);
      sort($modules);
      foreach ($modules as $module) {
        $display = $info[$module]['name'];
        if (module_hook($module, 'help')) {
          $items['items'][] = l($display, 'admin/help/' . $module);
        }
        else {
          $items['items'][] = $display;
        }
      }
      $output .= theme('item_list', $items) . '</dd>';
      $output .= '<dt>' . t('Managing field data storage') . '</dt>';
      $output .= '<dd>' . t('Developers of field modules can either use the default <a href="@sql-store">Field SQL storage module</a> to store data for their fields, or a contributed or custom module developed using the <a href="@storage-api">field storage API</a>.', array('@storage-api' => 'http://api.drupal.org/api/group/field_storage/7', '@sql-store' => url('admin/help/field_sql_storage'))) . '</dd>';
149
      $output .= '</dl>';
150 151 152 153 154
      return $output;
  }
}

/**
155
 * Implements hook_theme().
156 157
 */
function field_theme() {
158
  return array(
159
    'field' => array(
160
      'render element' => 'element',
161 162
    ),
    'field_multiple_value_form' => array(
163
      'render element' => 'element',
164 165 166 167
    ),
  );
}

168 169 170 171 172 173 174
/**
 * Implements hook_init().
 */
function field_init() {
  drupal_add_css(drupal_get_path('module', 'field') . '/theme/field.css', array('preprocess' => TRUE));
}

175
/**
176
 * Implements hook_cron().
177 178 179 180 181 182 183 184
 *
 * Purges some deleted Field API data, if any exists.
 */
function field_cron() {
  $limit = variable_get('field_purge_batch_size', 10);
  field_purge_batch($limit);
}

185
/**
186
 * Implements hook_modules_uninstalled().
187 188 189 190 191 192 193 194 195 196
 */
function field_modules_uninstalled($modules) {
  module_load_include('inc', 'field', 'field.crud');
  foreach ($modules as $module) {
    // TODO D7: field_module_delete is not yet implemented
    // field_module_delete($module);
  }
}

/**
197
 * Implements hook_modules_enabled().
198 199 200 201 202 203 204 205 206
 */
function field_modules_enabled($modules) {
  foreach ($modules as $module) {
    field_associate_fields($module);
  }
  field_cache_clear();
}

/**
207
 * Implements hook_modules_disabled().
208 209
 */
function field_modules_disabled($modules) {
210 211 212 213 214 215 216 217 218 219 220 221
  // Track fields whose field type is being disabled.
  db_update('field_config')
    ->fields(array('active' => 0))
    ->condition('module', $modules, 'IN')
    ->execute();

  // Track fields whose storage backend is being disabled.
  db_update('field_config')
    ->fields(array('storage_active' => 0))
    ->condition('storage_module', $modules, 'IN')
    ->execute();

222
  field_cache_clear();
223 224 225 226 227 228 229 230 231
}

/**
 * Allows a module to update the database for fields and columns it controls.
 *
 * @param string $module
 *   The name of the module to update on.
 */
function field_associate_fields($module) {
232 233 234 235 236 237 238 239
  // Associate field types.
  $field_types =(array) module_invoke($module, 'field_info');
  foreach ($field_types as $name => $field_info) {
    watchdog('field', 'Updating field type %type with module %module.', array('%type' => $name, '%module' => $module));
    db_update('field_config')
      ->fields(array('module' => $module, 'active' => 1))
      ->condition('type', $name)
      ->execute();
240
  }
241 242 243 244 245 246 247 248 249
  // Associate storage backends.
  $storage_types = (array) module_invoke($module, 'field_storage_info');
  foreach ($storage_types as $name => $storage_info) {
    watchdog('field', 'Updating field storage %type with module %module.', array('%type' => $name, '%module' => $module));
    db_update('field_config')
      ->fields(array('storage_module' => $module, 'storage_active' => 1))
      ->condition('storage_type', $name)
      ->execute();
  }
250 251
}

252
/**
253
 * Helper function to get the default value for a field on an entity.
254
 *
255 256 257
 * @param $entity_type
 *   The type of $entity; e.g. 'node' or 'user'.
 * @param $entity
258
 *   The entity for the operation.
259 260 261 262
 * @param $field
 *   The field structure.
 * @param $instance
 *   The instance structure.
263 264
 * @param $langcode
 *   The field language to fill-in with the default value.
265
 */
266
function field_get_default_value($entity_type, $entity, $field, $instance, $langcode = NULL) {
267 268 269
  $items = array();
  if (!empty($instance['default_value_function'])) {
    $function = $instance['default_value_function'];
270
    if (function_exists($function)) {
271
      $items = $function($entity_type, $entity, $field, $instance, $langcode);
272 273 274 275 276 277 278 279
    }
  }
  elseif (!empty($instance['default_value'])) {
    $items = $instance['default_value'];
  }
  return $items;
}

280
/**
281
 * Helper function to filter out empty field values.
282
 *
283 284 285 286
 * @param $field
 *   The field definition.
 * @param $items
 *   The field values to filter.
287
 *
288 289 290
 * @return
 *   The array of items without empty field values. The function also renumbers
 *   the array keys to ensure sequential deltas.
291
 */
292
function _field_filter_items($field, $items) {
293
  $function = $field['module'] . '_field_is_empty';
294
  function_exists($function);
295
  foreach ((array) $items as $delta => $item) {
296
    // Explicitly break if the function is undefined.
297 298
    if ($function($item, $field)) {
      unset($items[$delta]);
299 300
    }
  }
301
  return array_values($items);
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
}

/**
 * Helper function to sort items in a field according to
 * user drag-n-drop reordering.
 */
function _field_sort_items($field, $items) {
  if (($field['cardinality'] > 1 || $field['cardinality'] == FIELD_CARDINALITY_UNLIMITED) && isset($items[0]['_weight'])) {
    usort($items, '_field_sort_items_helper');
    foreach ($items as $delta => $item) {
      if (is_array($items[$delta])) {
        unset($items[$delta]['_weight']);
      }
    }
  }
  return $items;
}

/**
 * Sort function for items order.
 * (copied form element_sort(), which acts on #weight keys)
 */
function _field_sort_items_helper($a, $b) {
325 326 327
  $a_weight = (is_array($a) ? $a['_weight'] : 0);
  $b_weight = (is_array($b) ? $b['_weight'] : 0);
  return $a_weight - $b_weight;
328 329 330 331 332 333
}

/**
 * Same as above, using ['_weight']['#value']
 */
function _field_sort_items_value_helper($a, $b) {
334 335 336
  $a_weight = (is_array($a) && isset($a['_weight']['#value']) ? $a['_weight']['#value'] : 0);
  $b_weight = (is_array($b) && isset($b['_weight']['#value']) ? $b['_weight']['#value'] : 0);
  return $a_weight - $b_weight;
337 338
}

339
/**
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
 * Gets or sets administratively defined bundle settings.
 *
 * For each bundle, settings are provided as a nested array with the following
 * structure:
 * @code
 * array(
 *   'view_modes' => array(
 *     // One sub-array per view mode for the entity type:
 *     'full' => array(
 *       'custom_display' => Whether the view mode uses custom display
 *         settings or settings of the 'default' mode,
 *     ),
 *     'teaser' => ...
 *   ),
 *   'extra_fields' => array(
 *     'form' => array(
 *       // One sub-array per pseudo-field in displayed entities:
 *       'extra_field_1' => array(
 *         'weight' => The weight of the pseudo-field,
 *       ),
 *       'extra_field_2' => ...
 *     ),
 *     'display' => array(
 *       // One sub-array per pseudo-field in displayed entities:
 *       'extra_field_1' => array(
 *         // One sub-array per view mode for the entity type, including
 *         // the 'default' mode:
 *         'default' => array(
 *           'weight' => The weight of the pseudo-field,
 *           'visibility' => Whether the pseudo-field is visible or hidden,
 *         ),
 *         'full' => ...
 *       ),
 *       'extra_field_2' => ...
 *     ),
 *   ),
 * ),
377
 * @endcode
378
 *
379 380
 * @param $entity_type
 *   The type of $entity; e.g. 'node' or 'user'.
381
 * @param $bundle
382
 *   The bundle name.
383 384 385 386 387 388 389 390 391 392 393 394 395
 * @param $settings
 *   (optional) The settings to store.
 *
 * @return
 *   If no $settings are passed, the current settings are returned.
 */
function field_bundle_settings($entity_type, $bundle, $settings = NULL) {
  $stored_settings = variable_get('field_bundle_settings', array());

  if (isset($settings)) {
    $stored_settings[$entity_type][$bundle] = $settings;
    variable_set('field_bundle_settings', $stored_settings);
    drupal_static_reset('field_view_mode_settings');
396
    field_info_cache_clear();
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
  }
  else {
    $settings = isset($stored_settings[$entity_type][$bundle]) ? $stored_settings[$entity_type][$bundle] : array();
    $settings += array(
      'view_modes' => array(),
      'extra_fields' => array(),
    );

    return $settings;
  }
}

/**
 * Returns view mode settings in a given bundle.
 *
 * @param $entity_type
 *   The type of entity; e.g. 'node' or 'user'.
 * @param $bundle
 *   The bundle name to return view mode settings for.
 *
 * @return
 *   An array keyed by view mode, with the following key/value pairs:
 *   - custom_settings: Boolean specifying whether the view mode uses a
 *     dedicated set of display options (TRUE), or the 'default' options
 *     (FALSE). Defaults to FALSE.
 */
function field_view_mode_settings($entity_type, $bundle) {
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$entity_type][$bundle])) {
    $bundle_settings = field_bundle_settings($entity_type, $bundle);
    $settings = $bundle_settings['view_modes'];
    // Include view modes for which nothing has been stored yet, but whose
    // definition in hook_entity_info() specify they should use custom settings
    // by default.
    $entity_info = entity_get_info($entity_type);
    foreach ($entity_info['view modes'] as $view_mode => $view_mode_info) {
      if (!isset($settings[$view_mode]['custom_settings']) && $view_mode_info['custom settings']) {
        $settings[$view_mode]['custom_settings'] = TRUE;
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

  return $cache[$entity_type][$bundle];
}

/**
 * Returns the display settings to use for an instance in a given view mode.
 *
 * @param $instance
 *   The field instance being displayed.
 * @param $view_mode
 *   The view mode.
 *
 * @return
 *   The display settings to be used when displaying the field values.
 */
function field_get_display($instance, $view_mode) {
  // Check whether the view mode uses custom display settings or the 'default'
  // mode.
  $view_mode_settings = field_view_mode_settings($instance['entity_type'], $instance['bundle']);
  $actual_mode = (!empty($view_mode_settings[$view_mode]['custom_settings']) ? $view_mode : 'default');
  $display = $instance['display'][$actual_mode];

  // Let modules alter the display settings.
  $context = array(
    'entity_type' => $instance['entity_type'],
    'field' => field_info_field($instance['field_name']),
    'instance' => $instance,
    'view_mode' => $view_mode,
  );
  drupal_alter(array('field_display', 'field_display_' . $instance['entity_type']), $display, $context);

  return $display;
472 473 474
}

/**
475
 * Returns the display settings to use for pseudo-fields in a given view mode.
476
 *
477 478
 * @param $entity_type
 *   The type of $entity; e.g. 'node' or 'user'.
479 480
 * @param $bundle
 *   The bundle name.
481 482 483
 * @param $view_mode
 *   The view mode.
 *
484
 * @return
485 486 487 488 489 490 491
 *   The display settings to be used when viewing the bundle's pseudo-fields.
 */
function field_extra_fields_get_display($entity_type, $bundle, $view_mode) {
  // Check whether the view mode uses custom display settings or the 'default'
  // mode.
  $view_mode_settings = field_view_mode_settings($entity_type, $bundle);
  $actual_mode = (!empty($view_mode_settings[$view_mode]['custom_settings'])) ? $view_mode : 'default';
492
  $extra_fields = field_info_extra_fields($entity_type, $bundle, 'display');
493 494 495 496

  $displays = array();
  foreach ($extra_fields as $name => $value) {
    $displays[$name] = $extra_fields[$name]['display'][$actual_mode];
497
  }
498 499 500 501 502 503 504 505 506 507

  // Let modules alter the display settings.
  $context = array(
    'entity_type' => $entity_type,
    'bundle' => $bundle,
    'view_mode' => $view_mode,
  );
  drupal_alter('field_extra_fields_display', $displays, $context);

  return $displays;
508 509 510
}

/**
511
 * Pre-render callback to adjust weights and visibility of non-field elements.
512
 */
513 514 515 516 517
function _field_extra_fields_pre_render($elements) {
  $entity_type = $elements['#entity_type'];
  $bundle = $elements['#bundle'];

  if (isset($elements['#type']) && $elements['#type'] == 'form') {
518
    $extra_fields = field_info_extra_fields($entity_type, $bundle, 'form');
519 520 521
    foreach ($extra_fields as $name => $settings) {
      if (isset($elements[$name])) {
        $elements[$name]['#weight'] = $settings['weight'];
522
      }
523 524 525 526 527 528 529 530 531 532
    }
  }
  elseif (isset($elements['#view_mode'])) {
    $view_mode = $elements['#view_mode'];
    $extra_fields = field_extra_fields_get_display($entity_type, $bundle, $view_mode);
    foreach ($extra_fields as $name => $settings) {
      if (isset($elements[$name])) {
        $elements[$name]['#weight'] = $settings['weight'];
        // Visibility: make sure we do not accidentally show a hidden element.
        $elements[$name]['#access'] = isset($elements[$name]['#access']) ? ($elements[$name]['#access'] && $settings['visible']) : $settings['visible'];
533 534 535
      }
    }
  }
536

537 538 539
  return $elements;
}

540
/**
541
 * Clear the field info and field data caches.
542
 */
543
function field_cache_clear() {
544
  cache_clear_all('*', 'cache_field', TRUE);
545
  field_info_cache_clear();
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
}

/**
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
 * Used for items entered by administrators, like field descriptions,
 * allowed values, where some (mainly inline) mark-up may be desired
 * (so check_plain() is not acceptable).
 */
function field_filter_xss($string) {
  return filter_xss($string, _field_filter_xss_allowed_tags());
}

/**
 * List of tags allowed by field_filter_xss().
 */
function _field_filter_xss_allowed_tags() {
  return array('a', 'b', 'big',  'code', 'del', 'em', 'i', 'ins',  'pre', 'q', 'small', 'span', 'strong', 'sub', 'sup', 'tt', 'ol', 'ul', 'li', 'p', 'br', 'img');
}

/**
 * Human-readable list of allowed tags, for display in help texts.
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
574
 * Returns a renderable array for a single field value.
575
 *
576 577 578 579 580 581 582
 * @param $entity_type
 *   The type of $entity; e.g. 'node' or 'user'.
 * @param $entity
 *   The entity containing the field to display. Must at least contain the id
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
583
 * @param $item
584 585 586 587 588 589 590 591
 *   The field value to display, as found in
 *   $entity->field_name[$langcode][$delta].
 * @param $display
 *   Can be either the name of a view mode, or an array of display settings.
 *   See field_view_field() for more information.
 * @param $langcode
 *   (Optional) The language of the value in $item. If not provided, the
 *   current language will be assumed.
592
 * @return
593
 *   A renderable array for the field value.
594
 */
595 596
function field_view_value($entity_type, $entity, $field_name, $item, $display = array(), $langcode = NULL) {
  $output = array();
597

598 599
  if ($field = field_info_field($field_name)) {
    // Determine the langcode that will be used by language fallback.
600
    $langcode = field_language($entity_type, $entity, $field_name, $langcode);
601

602 603 604 605 606
    // Push the item as the single value for the field, and defer to
    // field_view_field() to build the render array for the whole field.
    $clone = clone $entity;
    $clone->{$field_name}[$langcode] = array($item);
    $elements = field_view_field($entity_type, $clone, $field_name, $display, $langcode);
607

608 609 610 611
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
612 613
    }
  }
614 615

  return $output;
616 617 618
}

/**
619
 * Returns a renderable array for the value of a single field in an entity.
620
 *
621
 * The resulting output is a fully themed field with label and multiple values.
622
 *
623 624 625 626
 * This function can be used by third-party modules that need to output an
 * isolated field.
 * - Do not use inside node (or other entities) templates, use
 *   render($content[FIELD_NAME]) instead.
627
 * - Do not use to display all fields in an entity, use
628
 *   field_attach_prepare_view() and field_attach_view() instead.
629
 *
630 631 632
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
633 634 635
 * @param $entity_type
 *   The type of $entity; e.g. 'node' or 'user'.
 * @param $entity
636
 *   The entity containing the field to display. Must at least contain the id
637 638 639 640 641
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
 * @param $display
 *   Can be either:
642 643
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
644
 *     definition for the field in the entity's bundle.
645
 *     If no display settings are found for the view mode, the settings for
646
 *     the 'default' view mode will be used.
647
 *   - An array of display settings, as found in the 'display' entry of
648
 *     $instance definitions. The following key/value pairs are allowed:
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
 *     - label: (string) Position of the label. The default 'field' theme
 *       implementation supports the values 'inline', 'above' and 'hidden'.
 *       Defaults to 'above'.
 *     - type: (string) The formatter to use. Defaults to the
 *       'default_formatter' for the field type, specified in
 *       hook_field_info(). The default formatter will also be used if the
 *       requested formatter is not available.
 *     - settings: (array) Settings specific to the formatter. Defaults to the
 *       formatter's default settings, specified in
 *       hook_field_formatter_info().
 *     - weight: (float) The weight to assign to the renderable element.
 *       Defaults to 0.
 * @param $langcode
 *   (Optional) The language the field values are to be shown in. The site's
 *   current language fallback logic will be applied no values are available
 *   for the language. If no language is provided the current language will be
 *   used.
666
 * @return
667
 *   A renderable array for the field value.
668
 */
669
function field_view_field($entity_type, $entity, $field_name, $display = array(), $langcode = NULL) {
670
  $output = array();
671

672 673 674 675 676
  if ($field = field_info_field($field_name)) {
    if (is_array($display)) {
      // When using custom display settings, fill in default values.
      $display = _field_info_prepare_instance_display($field, $display);
    }
677

678 679
    // Hook invocations are done through the _field_invoke() functions in
    // 'single field' mode, to reuse the language fallback logic.
680 681 682 683
    // Determine the actual language to display for the field, given the
    // languages available in the field data.
    $display_language = field_language($entity_type, $entity, $field_name, $langcode);
    $options = array('field_name' => $field_name, 'language' => $display_language);
684 685
    $null = NULL;

686 687 688 689 690 691 692 693 694 695
    // Invoke prepare_view steps if needed.
    if (empty($entity->_field_view_prepared)) {
      list($id) = entity_extract_ids($entity_type, $entity);

      // First let the field types do their preparation.
      _field_invoke_multiple('prepare_view', $entity_type, array($id => $entity), $display, $null, $options);
      // Then let the formatters do their own specific massaging.
      _field_invoke_multiple_default('prepare_view', $entity_type, array($id => $entity), $display, $null, $options);
    }

696
    // Build the renderable array.
697
    $result = _field_invoke_default('view', $entity_type, $entity, $display, $null, $options);
698

699
    // Invoke hook_field_attach_view_alter() to let other modules alter the
700 701
    // renderable array, as in a full field_attach_view() execution.
    $context = array(
702 703
      'entity_type' => $entity_type,
      'entity' => $entity,
704
      'view_mode' => '_custom',
705 706
    );
    drupal_alter('field_attach_view', $result, $context);
707

708 709 710
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
    }
711
  }
712

713 714 715
  return $output;
}

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
/**
 * Returns the field items in the language they currently would be displayed.
 *
 * @param $entity_type
 *   The type of $entity.
 * @param $entity
 *   The entity containing the data to be displayed.
 * @param $field_name
 *   The field to be displayed.
 * @param $langcode
 *   (optional) The language code $entity->{$field_name} has to be displayed in.
 *   Defaults to the current language.
 *
 * @return
 *   An array of field items keyed by delta if available, FALSE otherwise.
 */
function field_get_items($entity_type, $entity, $field_name, $langcode = NULL) {
  $langcode = field_language($entity_type, $entity, $field_name, $langcode);
  return isset($entity->{$field_name}[$langcode]) ? $entity->{$field_name}[$langcode] : FALSE;
}

737 738 739 740 741 742
/**
 * Determine whether a field has any data.
 *
 * @param $field
 *   A field structure.
 * @return
743
 *   TRUE if the field has data for any entity; FALSE otherwise.
744 745
 */
function field_has_data($field) {
746 747 748 749 750 751
  $query = new EntityFieldQuery();
  return (bool) $query
    ->fieldCondition($field)
    ->range(0, 1)
    ->count()
    ->execute();
752 753
}

754 755 756 757 758 759 760 761 762
/**
 * Determine whether the user has access to a given field.
 *
 * @param $op
 *   The operation to be performed. Possible values:
 *   - "edit"
 *   - "view"
 * @param $field
 *   The field on which the operation is to be performed.
763 764 765
 * @param $entity_type
 *   The type of $entity; e.g. 'node' or 'user'.
 * @param $entity
766
 *   (optional) The entity for the operation.
767 768 769 770 771 772
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
 * @return
 *   TRUE if the operation is allowed;
 *   FALSE if the operation is denied.
 */
773
function field_access($op, $field, $entity_type, $entity = NULL, $account = NULL) {
774 775
  global $user;

776
  if (!isset($account)) {
777 778 779
    $account = $user;
  }

780 781
  foreach (module_implements('field_access') as $module) {
    $function = $module . '_field_access';
782
    $access = $function($op, $field, $entity_type, $entity, $account);
783
    if ($access === FALSE) {
784 785 786 787 788 789
      return FALSE;
    }
  }
  return TRUE;
}

790
/**
791
 * Helper function to extract the bundle name of from a bundle object.
792
 *
793 794
 * @param $entity_type
 *   The type of $entity; e.g. 'node' or 'user'.
795
 * @param $bundle
796
 *   The bundle object (or string if bundles for this entity type do not exist
797 798 799 800
 *   as standalone objects).
 * @return
 *   The bundle name.
 */
801
function field_extract_bundle($entity_type, $bundle) {
802 803 804 805
  if (is_string($bundle)) {
    return $bundle;
  }

806
  $info = entity_get_info($entity_type);
807 808 809 810 811
  if (is_object($bundle) && isset($info['bundle keys']['bundle']) && isset($bundle->{$info['bundle keys']['bundle']})) {
    return $bundle->{$info['bundle keys']['bundle']};
  }
}

812
/**
813
 * Theme preprocess function for theme_field() and field.tpl.php.
814
 *
815
 * @see theme_field()
816 817
 * @see field.tpl.php
 */
818
function template_preprocess_field(&$variables, $hook) {
819 820
  $element = $variables['element'];

821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
  // There's some overhead in calling check_plain() so only call it if the label
  // variable is being displayed. Otherwise, set it to NULL to avoid PHP
  // warnings if a theme implementation accesses the variable even when it's
  // supposed to be hidden. If a theme implementation needs to print a hidden
  // label, it needs to supply a preprocess function that sets it to the
  // sanitized element title or whatever else is wanted in its place.
  $variables['label_hidden'] = ($element['#label_display'] == 'hidden');
  $variables['label'] = $variables['label_hidden'] ? NULL : check_plain($element['#title']);

  // We want other preprocess functions and the theme implementation to have
  // fast access to the field item render arrays. The item render array keys
  // (deltas) should always be a subset of the keys in #items, and looping on
  // those keys is faster than calling element_children() or looping on all keys
  // within $element, since that requires traversal of all element properties.
  $variables['items'] = array();
  foreach ($element['#items'] as $delta => $item) {
    if (!empty($element[$delta])) {
      $variables['items'][$delta] = $element[$delta];
    }
  }

  // Add default CSS classes. Since there can be many fields rendered on a page,
  // save some overhead by calling strtr() directly instead of
  // drupal_html_class().
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
  $variables['classes_array'] = array(
    'field',
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
852
  );
853 854 855 856 857
  // Add a "clearfix" class to the wrapper since we float the label and the
  // field items in field.css if the label is inline.
  if ($element['#label_display'] == 'inline') {
    $variables['classes_array'][] = 'clearfix';
  }
858

859 860 861 862 863 864
  // Add specific suggestions that can override the default implementation.
  $variables['theme_hook_suggestions'] = array(
    'field__' . $element['#field_name'],
    'field__' . $element['#bundle'],
    'field__' . $element['#field_name'] . '__' . $element['#bundle'],
  );
865 866
}

867
/**
868
 * Theme process function for theme_field() and field.tpl.php.
869
 *
870
 * @see theme_field()
871 872
 * @see field.tpl.php
 */
873 874 875 876 877 878 879 880 881 882
function template_process_field(&$variables, $hook) {
  // The default theme implementation is a function, so template_process() does
  // not automatically run, so we need to flatten the classes and attributes
  // here. For best performance, only call drupal_attributes() when needed, and
  // note that template_preprocess_field() does not initialize the
  // *_attributes_array variables.
  $variables['classes'] = implode(' ', $variables['classes_array']);
  $variables['attributes'] = empty($variables['attributes_array']) ? '' : drupal_attributes($variables['attributes_array']);
  $variables['title_attributes'] = empty($variables['title_attributes_array']) ? '' : drupal_attributes($variables['title_attributes_array']);
  $variables['content_attributes'] = empty($variables['content_attributes_array']) ? '' : drupal_attributes($variables['content_attributes_array']);
883
  foreach ($variables['items'] as $delta => $item) {
884
    $variables['item_attributes'][$delta] = empty($variables['item_attributes_array'][$delta]) ? '' : drupal_attributes($variables['item_attributes_array'][$delta]);
885 886
  }
}
887 888
/**
 * @} End of "defgroup field"
889
 */
890 891

/**
892
 * Returns HTML for a field.
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
 *
 * This is the default theme implementation to display the value of a field.
 * Theme developers who are comfortable with overriding theme functions may do
 * so in order to customize this markup. This function can be overridden with
 * varying levels of specificity. For example, for a field named 'body'
 * displayed on the 'article' content type, any of the following functions will
 * override this default implementation. The first of these functions that
 * exists is used:
 * - THEMENAME_field__body__article()
 * - THEMENAME_field__article()
 * - THEMENAME_field__body()
 * - THEMENAME_field()
 *
 * Theme developers who prefer to customize templates instead of overriding
 * functions may copy the "field.tpl.php" from the "modules/field/theme" folder
 * of the Drupal installation to somewhere within the theme's folder and
 * customize it, just like customizing other Drupal templates such as
 * page.tpl.php or node.tpl.php. However, it takes longer for the server to
 * process templates than to call a function, so for websites with many fields
 * displayed on a page, this can result in a noticeable slowdown of the website.
 * For these websites, developers are discouraged from placing a field.tpl.php
 * file into the theme's folder, but may customize templates for specific
 * fields. For example, for a field named 'body' displayed on the 'article'
 * content type, any of the following templates will override this default
 * implementation. The first of these templates that exists is used:
 * - field--body--article.tpl.php
 * - field--article.tpl.php
 * - field--body.tpl.php
 * - field.tpl.php
 * So, if the body field on the article content type needs customization, a
 * field--body--article.tpl.php file can be added within the theme's folder.
 * Because it's a template, it will result in slightly more time needed to
 * display that field, but it will not impact other fields, and therefore,
 * is unlikely to cause a noticeable change in website performance. A very rough
 * guideline is that if a page is being displayed with more than 100 fields and
 * they are all themed with a template instead of a function, it can add up to
 * 5% to the time it takes to display that page. This is a guideline only and
 * the exact performance impact depends on the server configuration and the
 * details of the website.
 *
933 934 935 936 937 938 939 940 941 942 943 944
 * @param $variables
 *   An associative array containing:
 *   - label_hidden: A boolean indicating to show or hide the field label.
 *   - title_attributes: A string containing the attributes for the title.
 *   - label: The label for the field.
 *   - content_attributes: A string containing the attaributes for the content's
 *     div.
 *   - items: An array of field items.
 *   - item_attributes: An array of attributes for each item.
 *   - classes: A string containing the classes for the wrapping div.
 *   - attributes: A string containing the attributes for the wrapping div.
 *
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
 * @see template_preprocess_field()
 * @see template_process_field()
 * @see field.tpl.php
 *
 * @ingroup themeable
 */
function theme_field($variables) {
  $output = '';

  // Render the label, if it's not hidden.
  if (!$variables['label_hidden']) {
    $output .= '<div class="field-label"' . $variables['title_attributes'] . '>' . $variables['label'] . ':&nbsp;</div>';
  }

  // Render the items.
  $output .= '<div class="field-items"' . $variables['content_attributes'] . '>';
  foreach ($variables['items'] as $delta => $item) {
    $classes = 'field-item ' . ($delta % 2 ? 'odd' : 'even');
    $output .= '<div class="' . $classes . '"' . $variables['item_attributes'][$delta] . '>' . drupal_render($item) . '</div>';
  }
  $output .= '</div>';

  // Render the top-level DIV.
968
  $output = '<div class="' . $variables['classes'] . '"' . $variables['attributes'] . '>' . $output . '</div>';
969 970 971

  return $output;
}