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

7
8
9
10
11
12
13
14
/**
 * 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 {}

15
/*
16
17
18
 * 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.
19
 */
20
21
22
23
24
25
require_once DRUPAL_ROOT . '/core/modules/field/field.crud.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.default.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.info.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.multilingual.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.attach.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.form.inc';
26

27
28
29
/**
 * @defgroup field Field API
 * @{
30
 * Attach custom data fields to Drupal entities.
31
32
 *
 * The Field API allows custom data fields to be attached to Drupal
33
34
 * entities and takes care of storing, loading, editing, and rendering
 * field data. Any entity type (node, user, etc.) can use the Field
35
 * API to make itself "fieldable" and thus allow fields to be attached
36
 * to it. Other modules can provide a user interface for managing custom
37
 * fields via a web browser as well as a wide and flexible variety of
38
39
 * data type, form element, and display format capabilities.
 *
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 * The Field API defines two primary data structures, Field and
 * Instance, and the concept of a Bundle. A Field defines a
 * particular type of data that can be attached to entities. A Field
 * Instance is a Field attached to a single Bundle. A Bundle is a set
 * of fields that are treated as a group by the Field Attach API and
 * is related to a single fieldable entity type.
 *
 * For example, suppose a site administrator wants Article nodes to
 * have a subtitle and photo. Using the Field API or Field UI module,
 * the administrator creates a field named 'subtitle' of type 'text'
 * and a field named 'photo' of type 'image'. The administrator
 * (again, via a UI) creates two Field Instances, one attaching the
 * field 'subtitle' to the 'node' bundle 'article' and one attaching
 * the field 'photo' to the 'node' bundle 'article'. When the node
 * system uses the Field Attach API to load all fields for an Article
 * node, it passes the node's entity type (which is 'node') and
 * content type (which is 'article') as the node's bundle.
 * field_attach_load() then loads the 'subtitle' and 'photo' fields
 * because they are both attached to the 'node' bundle 'article'.
 *
 * Field definitions are represented as an array of key/value pairs.
 *
 * array $field:
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 * - id (integer, read-only): The primary identifier of the field. It is
 *   assigned automatically by field_create_field().
 * - field_name (string): The name of the field. Each field name is unique
 *   within Field API. When a field is attached to an entity, the field's data
 *   is stored in $entity->$field_name. Maximum length is 32 characters.
 * - type (string): The type of the field, such as 'text' or 'image'. Field
 *   types are defined by modules that implement hook_field_info().
 * - entity_types (array): The array of entity types that can hold instances
 *   of this field. If empty or not specified, the field can have instances
 *   in any entity type.
 * - cardinality (integer): The number of values the field can hold. Legal
 *   values are any positive integer or FIELD_CARDINALITY_UNLIMITED.
 * - translatable (integer): Whether the field is translatable.
 * - locked (integer): Whether or not the field is available for editing. If
 *   TRUE, users can't change field settings or create new instances of the
 *   field in the UI. Defaults to FALSE.
 * - module (string, read-only): The name of the module that implements the
 *   field type.
 * - active (integer, read-only): TRUE if the module that implements the field
 *   type is currently enabled, FALSE otherwise.
 * - deleted (integer, read-only): TRUE if this field has been deleted, FALSE
 *   otherwise. Deleted fields are ignored by the Field Attach API. This
 *   property exists because fields can be marked for deletion but only
 *   actually destroyed by a separate garbage-collection process.
 * - columns (array, read-only): An array of the Field API columns used to
 *   store each value of this field. The column list may depend on field
 *   settings; it is not constant per field type. Field API column
 *   specifications are exactly like Schema API column specifications but,
 *   depending on the field storage module in use, the name of the column may
 *   not represent an actual column in an SQL database.
 * - indexes (array): An array of indexes on data columns, using the same
 *   definition format as Schema API index specifications. Only columns that
 *   appear in the 'columns' setting are allowed. Note that field types can
 *   specify default indexes, which can be modified or added to when
 *   creating a field.
98
 * - foreign keys: (optional) An associative array of relations, using the same
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 *   structure as the 'foreign keys' definition of hook_schema(). Note,
 *   however, that the field data is not necessarily stored in SQL. Also, the
 *   possible usage is limited, as you cannot specify another field as
 *   related, only existing SQL tables, such as filter formats.
 * - settings (array): A sub-array of key/value pairs of field-type-specific
 *   settings. Each field type module defines and documents its own field
 *   settings.
 * - storage (array): A sub-array of key/value pairs identifying the storage
 *   backend to use for the for the field:
 *   - type (string): The storage backend used by the field. Storage backends
 *     are defined by modules that implement hook_field_storage_info().
 *   - module (string, read-only): The name of the module that implements the
 *     storage backend.
 *   - active (integer, read-only): TRUE if the module that implements the
 *     storage backend is currently enabled, FALSE otherwise.
 *   - settings (array): A sub-array of key/value pairs of settings. Each
 *     storage backend defines and documents its own settings.
116
117
118
119
 *
 * Field instance definitions are represented as an array of key/value pairs.
 *
 * array $instance:
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 * - id (integer, read-only): The primary identifier of this field instance.
 *   It is assigned automatically by field_create_instance().
 * - field_id (integer, read-only): The foreign key of the field attached to
 *   the bundle by this instance. It is populated automatically by
 *   field_create_instance().
 * - field_name (string): The name of the field attached to the bundle by this
 *   instance.
 * - entity_type (string): The name of the entity type the instance is attached
 *   to.
 * - bundle (string): The name of the bundle that the field is attached to.
 * - label (string): A human-readable label for the field when used with this
 *   bundle. For example, the label will be the title of Form API elements
 *   for this instance.
 * - description (string): A human-readable description for the field when
 *   used with this bundle. For example, the description will be the help
 *   text of Form API elements for this instance.
 * - required (integer): TRUE if a value for this field is required when used
 *   with this bundle, FALSE otherwise. Currently, required-ness is only
 *   enforced during Form API operations, not by field_attach_load(),
 *   field_attach_insert(), or field_attach_update().
 * - default_value_function (string): The name of the function, if any, that
 *   will provide a default value.
 * - default_value (array): If default_value_function is not set, then fixed
 *   values can be provided.
 * - deleted (integer, read-only): TRUE if this instance has been deleted,
 *   FALSE otherwise. Deleted instances are ignored by the Field Attach API.
 *   This property exists because instances can be marked for deletion but
 *   only actually destroyed by a separate garbage-collection process.
 * - settings (array): A sub-array of key/value pairs of field-type-specific
 *   instance settings. Each field type module defines and documents its own
 *   instance settings.
 * - widget (array): A sub-array of key/value pairs identifying the Form API
 *   input widget for the field when used by this bundle:
 *   - type (string): The type of the widget, such as text_textfield. Widget
 *     types are defined by modules that implement hook_field_widget_info().
 *   - settings (array): A sub-array of key/value pairs of
 *     widget-type-specific settings. Each field widget type module defines
 *     and documents its own widget settings.
 *   - weight (float): The weight of the widget relative to the other elements
 *     in entity edit forms.
 *   - module (string, read-only): The name of the module that implements the
 *     widget type.
 * - display (array): A sub-array of key/value pairs identifying the way field
 *   values should be displayed in each of the entity type's view modes, plus
 *   the 'default' mode. For each view mode, Field UI lets site administrators
 *   define whether they want to use a dedicated set of display options or the
 *   'default' options to reduce the number of displays to maintain as they
 *   add new fields. For nodes, on a fresh install, only the 'teaser' view
 *   mode is configured to use custom display options, all other view modes
 *   defined use the 'default' options by default. When programmatically
 *   adding field instances on nodes, it is therefore recommended to at least
 *   specify display options for 'default' and 'teaser':
 *   - default (array): A sub-array of key/value pairs describing the display
 *     options to be used when the field is being displayed in view modes
 *     that are not configured to use dedicated display options:
 *     - label (string): Position of the label. 'inline', 'above' and
 *       'hidden' are the values recognized by the default 'field' theme
 *       implementation.
 *     - type (string): The type of the display formatter, or 'hidden' for
 *       no display.
 *     - settings (array): A sub-array of key/value pairs of display
 *       options specific to the formatter.
 *     - weight (float): The weight of the field relative to the other entity
 *       components displayed in this view mode.
 *     - module (string, read-only): The name of the module which implements
 *       the display formatter.
 *   - some_mode: A sub-array of key/value pairs describing the display
 *     options to be used when the field is being displayed in the 'some_mode'
 *     view mode. Those options will only be actually applied at run time if
 *     the view mode is not configured to use default settings for this bundle:
 *     - ...
 *   - other_mode:
 *     - ...
193
 *
194
195
196
 * The (default) render arrays produced for field instances are documented at
 * field_attach_view().
 *
197
 * Bundles are represented by two strings, an entity type and a bundle name.
198
 *
199
200
 * - @link field_types Field Types API @endlink. Defines field types,
 *   widget types, and display formatters. Field modules use this API
201
202
203
 *   to provide field types like Text and Node Reference along with the
 *   associated form elements and display formatters.
 *
204
 * - @link field_crud Field CRUD API @endlink. Create, updates, and
205
206
 *   deletes fields, bundles (a.k.a. "content types"), and instances.
 *   Modules use this API, often in hook_install(), to create
207
 *   custom data structures.
208
 *
209
 * - @link field_attach Field Attach API @endlink. Connects entity
210
 *   types to the Field API. Field Attach API functions load, store,
211
 *   generate Form API structures, display, and perform a variety of
212
213
 *   other functions for field data connected to individual entities.
 *   Fieldable entity types like node and user use this API to make
214
215
 *   themselves fieldable.
 *
216
 * - @link field_info Field Info API @endlink. Exposes information
217
218
219
 *   about all fields, instances, widgets, and related information
 *   defined by or with the Field API.
 *
220
221
 * - @link field_storage Field Storage API @endlink. Provides a
 *   pluggable back-end storage system for actual field data. The
222
223
 *   default implementation, field_sql_storage.module, stores field data
 *   in the local SQL database.
224
 *
225
226
227
 * - @link field_purge Field API bulk data deletion @endlink. Cleans
 *   up after bulk deletion operations such as field_delete_field()
 *   and field_delete_instance().
228
229
230
 *
 * - @link field_language Field language API @endlink. Provides native
 *   multilingual support for the Field API.
231
232
233
 */

/**
234
 * Value for field API indicating a field accepts an unlimited number of values.
235
 */
236
const FIELD_CARDINALITY_UNLIMITED = -1;
237
238

/**
239
240
241
 * Value for field API indicating a widget doesn't accept default values.
 *
 * @see hook_field_widget_info()
242
 */
243
const FIELD_BEHAVIOR_NONE = 0x0001;
244

245
/**
246
247
248
249
250
251
252
253
 * Value for field API concerning widget default and multiple value settings.
 *
 * @see hook_field_widget_info()
 *
 * When used in a widget default context, indicates the widget accepts default
 * values. When used in a multiple value context for a widget that allows the
 * input of one single field value, indicates that the widget will be repeated
 * for each value input.
254
 */
255
const FIELD_BEHAVIOR_DEFAULT = 0x0002;
256

257
/**
258
259
260
 * Value for field API indicating a widget can receive several field values.
 *
 * @see hook_field_widget_info()
261
 */
262
const FIELD_BEHAVIOR_CUSTOM = 0x0004;
263
264

/**
265
 * Age argument for loading the most recent version of an entity's
266
267
 * field data with field_attach_load().
 */
268
const FIELD_LOAD_CURRENT = 'FIELD_LOAD_CURRENT';
269

270
/**
271
272
 * Age argument for loading the version of an entity's field data
 * specified in the entity with field_attach_load().
273
 */
274
const FIELD_LOAD_REVISION = 'FIELD_LOAD_REVISION';
275

276
277
278
279
280
/**
 * Exception class thrown by hook_field_update_forbid().
 */
class FieldUpdateForbiddenException extends FieldException {}

281
/**
282
 * Implements hook_help().
283
284
285
286
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
287
288
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
289
      $output .= '<p>' . t('The Field module allows custom data fields to be defined for <em>entity</em> types (entities include content items, comments, user accounts, and taxonomy terms). The Field module 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 entity types "fieldable" and thus allow fields to be attached to them. 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/documentation/modules/field')) . '</p>';
290
291
292
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
293
      $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')));
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312

      // 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>';
313
      $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>';
314
      $output .= '</dl>';
315
316
317
318
319
      return $output;
  }
}

/**
320
 * Implements hook_theme().
321
322
 */
function field_theme() {
323
  return array(
324
    'field' => array(
325
      'render element' => 'element',
326
327
    ),
    'field_multiple_value_form' => array(
328
      'render element' => 'element',
329
330
331
332
    ),
  );
}

333
/**
334
 * Implements hook_cron().
335
336
 */
function field_cron() {
337
  // Refresh the 'active' status of fields.
338
  field_sync_field_status();
339
340

  // Do a pass of purging on deleted Field API data, if any exists.
341
342
343
344
  $limit = variable_get('field_purge_batch_size', 10);
  field_purge_batch($limit);
}

345
/**
346
347
348
349
 * Implements hook_system_info_alter().
 *
 * Goes through a list of all modules that provide a field type, and makes them
 * required if there are any active fields of that type.
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
377
378
function field_system_info_alter(&$info, $file, $type) {
  if ($type == 'module' && module_hook($file->name, 'field_info')) {
    $fields = field_read_fields(array('module' => $file->name), array('include_deleted' => TRUE));
    if ($fields) {
      $info['required'] = TRUE;

      // Provide an explanation message (only mention pending deletions if there
      // remains no actual, non-deleted fields)
      $non_deleted = FALSE;
      foreach ($fields as $field) {
        if (empty($field['deleted'])) {
          $non_deleted = TRUE;
          break;
        }
      }
      if ($non_deleted) {
        if (module_exists('field_ui')) {
          $explanation = t('Field type(s) in use - see !link', array('!link' => l(t('Field list'), 'admin/reports/fields')));
        }
        else {
          $explanation = t('Fields type(s) in use');
        }
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
379
380
381
382
  }
}

/**
383
 * Implements hook_cache_flush().
384
 */
385
386
387
388
389
390
391
392
393
function field_cache_flush() {
  // Request a flush of our cache table.
  return array('field');
}

/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
394
  // Refresh the 'active' status of fields.
395
396
397
  field_sync_field_status();
}

398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
/**
 * Implements hook_modules_enabled().
 */
function field_modules_enabled($modules) {
  // Refresh the 'active' status of fields.
  field_sync_field_status();
}

/**
 * Implements hook_modules_disabled().
 */
function field_modules_disabled($modules) {
  // Refresh the 'active' status of fields.
  field_sync_field_status();
}

414
415
416
417
418
419
420
421
422
423
424
425
426
427
/**
 * Refreshes the 'active' and 'storage_active' columns for fields.
 */
function field_sync_field_status() {
  // Refresh the 'active' and 'storage_active' columns according to the current
  // set of enabled modules.
  $all_modules = system_rebuild_module_data();
  $modules = array();
  foreach ($all_modules as $module_name => $module) {
    if ($module->status) {
      $modules[] = $module_name;
      field_associate_fields($module_name);
    }
  }
428
429
  db_update('field_config')
    ->fields(array('active' => 0))
430
    ->condition('module', $modules, 'NOT IN')
431
432
433
    ->execute();
  db_update('field_config')
    ->fields(array('storage_active' => 0))
434
    ->condition('storage_module', $modules, 'NOT IN')
435
    ->execute();
436
437
438
439
440
}

/**
 * Allows a module to update the database for fields and columns it controls.
 *
441
 * @param $module
442
443
444
 *   The name of the module to update on.
 */
function field_associate_fields($module) {
445
  // Associate field types.
446
  $field_types = (array) module_invoke($module, 'field_info');
447
  if ($field_types) {
448
449
    db_update('field_config')
      ->fields(array('module' => $module, 'active' => 1))
450
      ->condition('type', array_keys($field_types))
451
      ->execute();
452
  }
453
454
  // Associate storage backends.
  $storage_types = (array) module_invoke($module, 'field_storage_info');
455
  if ($storage_types) {
456
457
    db_update('field_config')
      ->fields(array('storage_module' => $module, 'storage_active' => 1))
458
      ->condition('storage_type', array_keys($storage_types))
459
460
      ->execute();
  }
461
462
}

463
/**
464
 * Helper function to get the default value for a field on an entity.
465
 *
466
 * @param $entity_type
467
 *   The type of $entity; e.g., 'node' or 'user'.
468
 * @param $entity
469
 *   The entity for the operation.
470
471
472
473
 * @param $field
 *   The field structure.
 * @param $instance
 *   The instance structure.
474
475
 * @param $langcode
 *   The field language to fill-in with the default value.
476
 */
477
function field_get_default_value($entity_type, $entity, $field, $instance, $langcode = NULL) {
478
479
480
  $items = array();
  if (!empty($instance['default_value_function'])) {
    $function = $instance['default_value_function'];
481
    $items = $function($entity_type, $entity, $field, $instance, $langcode);
482
483
484
485
486
487
488
  }
  elseif (!empty($instance['default_value'])) {
    $items = $instance['default_value'];
  }
  return $items;
}

489
/**
490
 * Helper function to filter out empty field values.
491
 *
492
493
494
495
 * @param $field
 *   The field definition.
 * @param $items
 *   The field values to filter.
496
 *
497
498
499
 * @return
 *   The array of items without empty field values. The function also renumbers
 *   the array keys to ensure sequential deltas.
500
 */
501
function _field_filter_items($field, $items) {
502
503
  $function = $field['module'] . '_field_is_empty';
  foreach ((array) $items as $delta => $item) {
504
    // Explicitly break if the function is undefined.
505
506
    if ($function($item, $field)) {
      unset($items[$delta]);
507
508
    }
  }
509
  return array_values($items);
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
}

/**
 * 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) {
533
534
535
  $a_weight = (is_array($a) ? $a['_weight'] : 0);
  $b_weight = (is_array($b) ? $b['_weight'] : 0);
  return $a_weight - $b_weight;
536
537
538
539
540
541
}

/**
 * Same as above, using ['_weight']['#value']
 */
function _field_sort_items_value_helper($a, $b) {
542
543
544
  $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;
545
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
574
575
576
 * 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,
577
 *           'visible' => TRUE if the pseudo-field is visible, FALSE if hidden,
578
579
580
581
582
583
 *         ),
 *         'full' => ...
 *       ),
 *       'extra_field_2' => ...
 *     ),
 *   ),
584
 * );
585
 * @endcode
586
 *
587
 * @param $entity_type
588
 *   The type of $entity; e.g., 'node' or 'user'.
589
 * @param $bundle
590
 *   The bundle name.
591
592
593
594
595
596
597
598
 * @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) {
  if (isset($settings)) {
599
    variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle, $settings);
600
    field_info_cache_clear();
601
602
  }
  else {
603
    $settings = variable_get('field_bundle_settings_' . $entity_type . '__' . $bundle, array());
604
605
606
607
    $settings += array(
      'view_modes' => array(),
      'extra_fields' => array(),
    );
608
609
610
611
    $settings['extra_fields'] += array(
      'form' => array(),
      'display' => array(),
    );
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658

    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.
659
660
 * @param $entity
 *   The entity being displayed.
661
662
663
664
 *
 * @return
 *   The display settings to be used when displaying the field values.
 */
665
function field_get_display($instance, $view_mode, $entity) {
666
667
668
669
670
671
672
673
674
675
676
  // 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,
677
    'entity' => $entity,
678
679
680
681
682
    'view_mode' => $view_mode,
  );
  drupal_alter(array('field_display', 'field_display_' . $instance['entity_type']), $display, $context);

  return $display;
683
684
685
}

/**
686
 * Returns the display settings to use for pseudo-fields in a given view mode.
687
 *
688
 * @param $entity_type
689
 *   The type of $entity; e.g., 'node' or 'user'.
690
691
 * @param $bundle
 *   The bundle name.
692
693
694
 * @param $view_mode
 *   The view mode.
 *
695
 * @return
696
697
698
699
700
701
702
 *   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';
703
  $extra_fields = field_info_extra_fields($entity_type, $bundle, 'display');
704
705
706
707

  $displays = array();
  foreach ($extra_fields as $name => $value) {
    $displays[$name] = $extra_fields[$name]['display'][$actual_mode];
708
  }
709
710
711
712
713
714
715
716
717
718

  // 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;
719
720
721
}

/**
722
 * Pre-render callback to adjust weights and visibility of non-field elements.
723
 */
724
725
726
727
728
function _field_extra_fields_pre_render($elements) {
  $entity_type = $elements['#entity_type'];
  $bundle = $elements['#bundle'];

  if (isset($elements['#type']) && $elements['#type'] == 'form') {
729
    $extra_fields = field_info_extra_fields($entity_type, $bundle, 'form');
730
731
732
    foreach ($extra_fields as $name => $settings) {
      if (isset($elements[$name])) {
        $elements[$name]['#weight'] = $settings['weight'];
733
      }
734
735
736
737
738
739
740
741
742
743
    }
  }
  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'];
744
745
746
      }
    }
  }
747

748
749
750
  return $elements;
}

751
/**
752
 * Clear the field info and field data caches.
753
 */
754
function field_cache_clear() {
755
  cache('field')->flush();
756
  field_info_cache_clear();
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
}

/**
 * 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()) . '>';
}

/**
785
 * Returns a renderable array for a single field value.
786
 *
787
 * @param $entity_type
788
 *   The type of $entity; e.g., 'node' or 'user'.
789
790
791
792
793
 * @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.
794
 * @param $item
795
796
797
798
799
800
801
802
 *   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.
803
 * @return
804
 *   A renderable array for the field value.
805
 */
806
807
function field_view_value($entity_type, $entity, $field_name, $item, $display = array(), $langcode = NULL) {
  $output = array();
808

809
810
  if ($field = field_info_field($field_name)) {
    // Determine the langcode that will be used by language fallback.
811
    $langcode = field_language($entity_type, $entity, $field_name, $langcode);
812

813
814
815
816
817
    // 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);
818

819
820
821
822
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
823
824
    }
  }
825
826

  return $output;
827
828
829
}

/**
830
 * Returns a renderable array for the value of a single field in an entity.
831
 *
832
 * The resulting output is a fully themed field with label and multiple values.
833
 *
834
835
836
837
 * 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.
838
 * - Do not use to display all fields in an entity, use
839
 *   field_attach_prepare_view() and field_attach_view() instead.
840
841
 * - The field_view_value() function can be used to output a single formatted
 *   field value, without label or wrapping field markup.
842
 *
843
844
845
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
846
 * @param $entity_type
847
 *   The type of $entity; e.g., 'node' or 'user'.
848
 * @param $entity
849
 *   The entity containing the field to display. Must at least contain the id
850
851
852
853
854
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
 * @param $display
 *   Can be either:
855
856
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
857
 *     definition for the field in the entity's bundle.
858
 *     If no display settings are found for the view mode, the settings for
859
 *     the 'default' view mode will be used.
860
 *   - An array of display settings, as found in the 'display' entry of
861
 *     $instance definitions. The following key/value pairs are allowed:
862
863
864
865
866
867
868
869
870
871
872
873
874
 *     - 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
875
876
877
878
 *   (Optional) The language code the field values are to be shown in. The
 *   site's current language fallback logic will be applied when no values are
 *   available for given language code. If no language code is provided the
 *   current language will be used.
879
 * @return
880
 *   A renderable array for the field value.
881
882
 *
 * @see field_view_value()
883
 */
884
function field_view_field($entity_type, $entity, $field_name, $display = array(), $langcode = NULL) {
885
  $output = array();
886

887
888
889
890
891
  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);
    }
892

893
894
    // Hook invocations are done through the _field_invoke() functions in
    // 'single field' mode, to reuse the language fallback logic.
895
896
897
898
    // Determine the actual language code to display for the field, given the
    // language codes available in the field data.
    $display_langcode = field_language($entity_type, $entity, $field_name, $langcode);
    $options = array('field_name' => $field_name, 'langcode' => $display_langcode);
899
900
    $null = NULL;

901
902
903
904
905
906
907
908
909
910
    // 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);
    }

911
    // Build the renderable array.
912
    $result = _field_invoke_default('view', $entity_type, $entity, $display, $null, $options);
913

914
    // Invoke hook_field_attach_view_alter() to let other modules alter the
915
916
    // renderable array, as in a full field_attach_view() execution.
    $context = array(
917
918
      'entity_type' => $entity_type,
      'entity' => $entity,
919
      'view_mode' => '_custom',
920
      'display' => $display,
921
922
    );
    drupal_alter('field_attach_view', $result, $context);
923

924
925
926
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
    }
927
  }
928

929
930
931
  return $output;
}

932
933
934
935
/**
 * Returns the field items in the language they currently would be displayed.
 *
 * @param $entity_type
936
 *   The type of $entity; e.g., 'node' or 'user'.
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 * @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;
}

953
954
955
956
957
958
/**
 * Determine whether a field has any data.
 *
 * @param $field
 *   A field structure.
 * @return
959
 *   TRUE if the field has data for any entity; FALSE otherwise.
960
961
 */
function field_has_data($field) {
962
963
964
965
966
  $query = new EntityFieldQuery();
  return (bool) $query
    ->fieldCondition($field)
    ->range(0, 1)
    ->count()
967
968
969
970
    // Neutralize the 'entity_field_access' query tag added by
    // field_sql_storage_field_storage_query(). The result cannot depend on the
    // access grants of the current user.
    ->addTag('DANGEROUS_ACCESS_CHECK_OPT_OUT')
971
    ->execute();
972
973
}

974
975
976
/**
 * Determine whether the user has access to a given field.
 *
977
 * @param string $op
978
 *   The operation to be performed. Possible values:
979
980
981
982
983
984
 *   - 'edit'
 *   - 'view'
 * @param array $field
 *   The full field structure array for the field on which the operation is to
 *   be performed. See field_info_field().
 * @param string $entity_type
985
 *   The type of $entity; e.g., 'node' or 'user'.
986
 * @param $entity
987
 *   (optional) The entity for the operation.
988
989
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
990
 *
991
992
993
994
 * @return
 *   TRUE if the operation is allowed;
 *   FALSE if the operation is denied.
 */
995
function field_access($op, $field, $entity_type, $entity = NULL, $account = NULL) {
996
997
  global $user;

998
  if (!isset($account)) {
999
1000
1001
    $account = $user;
  }

1002
1003
  foreach (module_implements('field_access') as $module) {
    $function = $module . '_field_access';
1004
    $access = $function($op, $field, $entity_type, $entity, $account);
1005
    if ($access === FALSE) {
1006
1007
1008
1009
1010
1011
      return FALSE;
    }
  }
  return TRUE;
}

1012
/**
1013
 * Helper function to extract the bundle name of from a bundle object.
1014
 *
1015
 * @param $entity_type
1016
 *   The type of $entity; e.g., 'node' or 'user'.
1017
 * @param $bundle
1018
 *   The bundle object (or string if bundles for this entity type do not exist
1019
1020
1021
1022
 *   as standalone objects).
 * @return
 *   The bundle name.
 */
1023
function field_extract_bundle($entity_type, $bundle) {
1024
1025
1026
1027
  if (is_string($bundle)) {
    return $bundle;
  }

1028
  $info = entity_get_info($entity_type);
1029
1030
1031
1032
1033
  if (is_object($bundle) && isset($info['bundle keys']['bundle']) && isset($bundle->{$info['bundle keys']['bundle']})) {
    return $bundle->{$info['bundle keys']['bundle']};
  }
}

1034
/**
1035
 * Theme preprocess function for theme_field() and field.tpl.php.
1036
 *
1037
 * @see theme_field()
1038
1039
 * @see field.tpl.php
 */
1040
function template_preprocess_field(&$variables, $hook) {
1041
1042
  $element = $variables['element'];

1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
  // 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'],
1074
  );
1075
1076
1077
1078
1079
  // 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';
  }
1080

1081
1082
  // Add specific suggestions that can override the default implementation.
  $variables['theme_hook_suggestions'] = array(
1083
    'field__' . $element['#field_type'],
1084
1085
1086
1087
    'field__' . $element['#field_name'],
    'field__' . $element['#bundle'],
    'field__' . $element['#field_name'] . '__' . $element['#bundle'],
  );
1088
1089
}

1090
/**
1091
 * Theme process function for theme_field() and field.tpl.php.
1092
 *
1093
 * @see theme_field()
1094
1095
 * @see field.tpl.php
 */
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
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']);
1106
  foreach ($variables['items'] as $delta => $item) {
1107
    $variables['item_attributes'][$delta] = empty($variables['item_attributes_array'][$delta]) ? '' : drupal_attributes($variables['item_attributes_array'][$delta]);
1108
1109
  }
}
1110
1111
/**
 * @} End of "defgroup field"
1112
 */
1113
1114

/**
1115
 * Returns HTML for a field.
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
 *
 * 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.
 *
1156
1157
1158
1159
1160
 * @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.
1161
 *   - content_attributes: A string containing the attributes for the content's
1162
1163
1164
1165
1166
1167
 *     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.
 *
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 * @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.
1191
  $output = '<div class="' . $variables['classes'] . '"' . $variables['attributes'] . '>' . $output . '</div>';
1192
1193
1194

  return $output;
}