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

7
use Drupal\Core\Entity\EntityInterface;
8
use Drupal\Core\Language\Language;
9
use Drupal\Core\Template\Attribute;
10
use Drupal\field\FieldInterface;
11
use Drupal\field\FieldInstanceInterface;
12

13
/*
14
15
16
 * 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.
17
 */
18
19
20
21
require_once __DIR__ . '/field.info.inc';
require_once __DIR__ . '/field.multilingual.inc';
require_once __DIR__ . '/field.attach.inc';
require_once __DIR__ . '/field.form.inc';
22
23
require_once __DIR__ . '/field.purge.inc';
require_once __DIR__ . '/field.deprecated.inc';
24

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

/**
84
 * Value for field API indicating a field accepts an unlimited number of values.
85
 */
86
const FIELD_CARDINALITY_UNLIMITED = -1;
87
88

/**
89
90
91
 * Value for field API indicating a widget doesn't accept default values.
 *
 * @see hook_field_widget_info()
92
 */
93
const FIELD_BEHAVIOR_NONE = 0x0001;
94

95
/**
96
97
98
99
100
101
102
103
 * 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.
104
 */
105
const FIELD_BEHAVIOR_DEFAULT = 0x0002;
106

107
/**
108
109
110
 * Value for field API indicating a widget can receive several field values.
 *
 * @see hook_field_widget_info()
111
 */
112
const FIELD_BEHAVIOR_CUSTOM = 0x0004;
113
114

/**
115
116
117
 * Load the most recent version of an entity's field data.
 *
 * @see field_attach_load().
118
 */
119
const FIELD_LOAD_CURRENT = 'FIELD_LOAD_CURRENT';
120

121
/**
122
123
124
 * Load the version of an entity's field data specified in the entity.
 *
 * @see field_attach_load().
125
 */
126
const FIELD_LOAD_REVISION = 'FIELD_LOAD_REVISION';
127
128

/**
129
 * Implements hook_help().
130
131
132
133
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
134
135
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
136
      $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>';
137
138
139
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
140
      $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')));
141
142
143
144
145

      // 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');
146
      $modules = array_merge(Drupal::moduleHandler()->getImplementations('field_info'), Drupal::moduleHandler()->getImplementations('field_widget_info'));
147
148
149
150
      $modules = array_unique($modules);
      sort($modules);
      foreach ($modules as $module) {
        $display = $info[$module]['name'];
151
        if (Drupal::moduleHandler()->implementsHook($module, 'help')) {
152
153
154
155
156
157
          $items['items'][] = l($display, 'admin/help/' . $module);
        }
        else {
          $items['items'][] = $display;
        }
      }
158
159
160
161
162
      $item_list = array(
        '#theme' => 'item_list',
        '#items' => $items['items'],
      );
      $output .= drupal_render($item_list) . '</dd>';
163
      $output .= '<dt>' . t('Managing field data storage') . '</dt>';
164
      $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/8', '@sql-store' => url('admin/help/field_sql_storage'))) . '</dd>';
165
      $output .= '</dl>';
166
167
168
169
170
      return $output;
  }
}

/**
171
 * Implements hook_theme().
172
173
 */
function field_theme() {
174
  return array(
175
    'field' => array(
176
      'render element' => 'element',
177
178
    ),
    'field_multiple_value_form' => array(
179
      'render element' => 'element',
180
181
182
183
    ),
  );
}

184
/**
185
 * Implements hook_cron().
186
187
 */
function field_cron() {
188
  // Refresh the 'active' status of fields.
189
  field_sync_field_status();
190
191

  // Do a pass of purging on deleted Field API data, if any exists.
192
  $limit = Drupal::config('field.settings')->get('purge_batch_size');
193
194
195
  field_purge_batch($limit);
}

196
/**
197
198
 * Implements hook_system_info_alter().
 *
199
 * Goes through a list of all modules that provide a field type and makes them
200
 * required if there are any active fields of that type.
201
 */
202
function field_system_info_alter(&$info, $file, $type) {
203
  // It is not safe to call field_read_fields() during maintenance mode.
204
  if ($type == 'module' && !defined('MAINTENANCE_MODE')) {
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
    $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')) {
220
          $explanation = t('Field type(s) in use - see <a href="@fields-page">Field list</a>', array('@fields-page' => url('admin/reports/fields')));
221
222
223
224
225
226
227
228
229
230
        }
        else {
          $explanation = t('Fields type(s) in use');
        }
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
231
232
233
  }
}

234
235
236
237
238
239
240
241
242
243
/**
 * Implements hook_entity_field_info() to define all configured fields.
 */
function field_entity_field_info($entity_type) {
  $property_info = array();

  foreach (field_info_instances($entity_type) as $bundle_name => $instances) {
    $optional = $bundle_name != $entity_type;

    foreach ($instances as $field_name => $instance) {
244
      $definition = _field_generate_entity_field_definition($instance->getField());
245

246
247
248
249
250
251
      if ($optional) {
        $property_info['optional'][$field_name] = $definition;
        $property_info['bundle map'][$bundle_name][] = $field_name;
      }
      else {
        $property_info['definitions'][$field_name] = $definition;
252
253
254
255
256
257
258
      }
    }
  }

  return $property_info;
}

259
260
261
262
263
264
265
266
267
268
269
270
271
272
/**
 * Generates an entity field definition for a configurable field.
 *
 * @param \Drupal\field\FieldInterface $field
 *   The field definition.
 * @param \Drupal\field\FieldInstanceInterface $instance
 *   (Optional) The field instance definition.
 *
 * @return array
 *   The entity field definition.
 */
function _field_generate_entity_field_definition(FieldInterface $field, FieldInstanceInterface $instance = NULL) {
  // @todo: Allow for adding field type settings.
  $definition = array(
273
    'label' => t('Field !name', array('!name' => $field->name)),
274
275
276
277
278
279
280
281
282
283
284
285
    'type' => 'field_item:' . $field->type,
    'list' => TRUE,
    'configurable' => TRUE,
    'translatable' => !empty($field->translatable),
  );
  if ($instance) {
    $definition['instance'] = $instance;
  }

  return $definition;
}

286
287
288
289
290
/**
 * Implements hook_field_widget_info_alter().
 */
function field_field_widget_info_alter(&$info) {
  // Add the Hidden widget to all field types.
291
  $info['hidden']['field_types'] = array_keys(\Drupal::service('plugin.manager.entity.field.field_type')->getDefinitions());
292
293
}

294
/**
295
 * Implements hook_entity_bundle_create().
296
 */
297
298
299
300
function field_entity_bundle_create($entity_type, $bundle) {
  // Clear the cache.
  field_cache_clear();
}
301

302
303
304
305
306
307
308
309
310
311
312
313
/**
 * Implements hook_entity_bundle_rename().
 */
function field_entity_bundle_rename($entity_type, $bundle_old, $bundle_new) {
  $instances = field_read_instances();
  foreach ($instances as $instance) {
    if ($instance->entity_type == $entity_type && $instance->bundle == $bundle_old) {
      $id_new = $instance['entity_type'] . '.' . $bundle_new . '.' . $instance['field_name'];
      $instance->id = $id_new;
      $instance->bundle = $bundle_new;
      $instance->allowBundleRename();
      $instance->save();
314
315
    }
  }
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349

  // Clear the field cache.
  field_cache_clear();

  // Update bundle settings.
  $settings = variable_get('field_bundle_settings_' . $entity_type . '__' . $bundle_old, array());
  variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle_new, $settings);
  variable_del('field_bundle_settings_' . $entity_type . '__' . $bundle_old);
}

/**
 * Implements hook_entity_bundle_delete().
 *
 * This deletes the data for the field instances as well as the field instances
 * themselves. This function actually just marks the data and field instances as
 * deleted, leaving the garbage collection for a separate process, because it is
 * not always possible to delete this much data in a single page request
 * (particularly since for some field types, the deletion is more than just a
 * simple DELETE query).
 */
function field_entity_bundle_delete($entity_type, $bundle) {
  // Get the instances on the bundle. field_read_instances() must be used
  // here since field_info_instances() does not return instances for disabled
  // entity types or bundles.
  $instances = field_read_instances(array('entity_type' => $entity_type, 'bundle' => $bundle), array('include_inactive' => TRUE));
  foreach ($instances as $instance) {
    $instance->delete();
  }

  // Clear the cache.
  field_cache_clear();

  // Clear bundle display settings.
  variable_del('field_bundle_settings_' . $entity_type . '__' . $bundle);
350
351
}

352
353
354
355
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
356
  // Refresh the 'active' status of fields.
357
358
359
  field_sync_field_status();
}

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
/**
 * 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();
}

376
/**
377
 * Refreshes the 'active' and 'storage[active]' values for fields.
378
379
 */
function field_sync_field_status() {
380
381
382
383
384
  $module_handler = Drupal::moduleHandler();
  $state = Drupal::state();

  // Get both deleted and non-deleted field definitions.
  $fields = array();
385
  foreach (config_get_storage_names_with_prefix('field.field.') as $name) {
386
387
    $field = Drupal::config($name)->get();
    $fields[$field['uuid']] = $field;
388
  }
389
390
  $deleted_fields = $state->get('field.field.deleted') ?: array();
  $fields += $deleted_fields;
391

392
393
  if (empty($fields)) {
    return;
394
  }
395
396
397
398
399

  // Set the 'module' and 'active' values for the current set of enabled
  // modules.
  $changed = array();
  $modules = $module_handler->getModuleList();
400
  $field_types = Drupal::service('plugin.manager.entity.field.field_type')->getDefinitions();
401
  // Set fields with missing field type modules to inactive.
402
  foreach ($fields as $uuid => &$field) {
403
    // Associate field types.
404
405
    if (isset($field_types[$field['type']]) && ($field['module'] != $field_types[$field['type']]['provider'] || !$field['active'])) {
      $field['module'] = $field_types[$field['type']]['provider'];
406
407
408
      $field['active'] = TRUE;
      $changed[$uuid] = $field;
    }
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
    if (!isset($modules[$field['module']]) && $field['active']) {
      $field['active'] = FALSE;
      $changed[$uuid] = $field;
    }
  }

  // Store the updated field definitions.
  foreach ($changed as $uuid => $field) {
    if (!empty($field['deleted'])) {
      $deleted_fields[$uuid] = $field;
    }
    else {
      Drupal::config('field.field.' . $field['id'])
        ->set('module', $field['module'])
        ->set('active', $field['active'])
        ->save();
    }
  }
  $state->set('field.field.deleted', $deleted_fields);

  field_cache_clear();
430
431
}

432
/**
433
434
 * Gets or sets administratively defined bundle settings.
 *
435
 * @param string $entity_type
436
 *   The type of $entity; e.g., 'node' or 'user'.
437
 * @param string $bundle
438
 *   The bundle name.
439
440
441
442
443
 * @param array|null $settings
 *   (optional) The settings to store, an associative array with the following
 *   elements:
 *   - view_modes: An associative array keyed by view mode, with the following
 *     key/value pairs:
444
445
446
 *     - status: Boolean specifying whether the view mode uses a dedicated set
 *       of display options (TRUE), or the 'default' options (FALSE). Defaults
 *       to FALSE.
447
448
449
450
451
452
453
454
455
456
457
458
459
 *   - extra_fields: An associative array containing the form and display
 *     settings for extra fields (also known as pseudo-fields):
 *     - form: An associative array whose keys are the names of extra fields,
 *       and whose values are associative arrays with the following elements:
 *       - weight: The weight of the extra field, determining its position on an
 *         entity form.
 *     - display: An associative array whose keys are the names of extra fields,
 *       and whose values are associative arrays keyed by the name of view
 *       modes. This array must include an item for the 'default' view mode.
 *       Each view mode sub-array contains the following elements:
 *       - weight: The weight of the extra field, determining its position when
 *         an entity is viewed.
 *       - visible: TRUE if the extra field is visible, FALSE otherwise.
460
 *
461
 * @return array|null
462
463
464
465
 *   If no $settings are passed, the current settings are returned.
 */
function field_bundle_settings($entity_type, $bundle, $settings = NULL) {
  if (isset($settings)) {
466
    variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle, $settings);
467
    field_info_cache_clear();
468
469
  }
  else {
470
    $settings = variable_get('field_bundle_settings_' . $entity_type . '__' . $bundle, array());
471
472
    $settings += array(
      'view_modes' => array(),
473
      'form_modes' => array(),
474
    );
475
476
477
478
479

    return $settings;
  }
}

480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
/**
 * Returns form mode settings in a given bundle.
 *
 * @param string $entity_type
 *   The type of entity; e.g. 'node' or 'user'.
 * @param string $bundle
 *   The bundle name to return form mode settings for.
 *
 * @return
 *   An array keyed by form mode, with the following key/value pairs:
 *   - status: Boolean specifying whether the form mode uses a dedicated set of
 *     display options (TRUE), or the 'default' options (FALSE). Defaults to
 *     FALSE.
 */
function field_form_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['form_modes'];
    // Include form modes for which nothing has been stored yet, but whose
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
    $form_modes = entity_get_form_modes($entity_type);
    foreach ($form_modes as $form_mode => $form_mode_info) {
      if (!isset($settings[$form_mode]['status']) && $form_mode_info['status']) {
        $settings[$form_mode]['status'] = TRUE;
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

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

515
516
517
518
519
520
521
522
523
524
/**
 * 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:
525
526
527
 *   - status: Boolean specifying whether the view mode uses a dedicated set of
 *     display options (TRUE), or the 'default' options (FALSE). Defaults to
 *     FALSE.
528
529
530
531
532
533
534
535
 */
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
536
537
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
538
539
    $view_modes = entity_get_view_modes($entity_type);
    foreach ($view_modes as $view_mode => $view_mode_info) {
540
541
      if (!isset($settings[$view_mode]['status']) && $view_mode_info['status']) {
        $settings[$view_mode]['status'] = TRUE;
542
543
544
545
546
547
548
549
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

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

550
/**
551
 * Clears the field info and field data caches.
552
 */
553
function field_cache_clear() {
554
  cache('field')->deleteAll();
555
  field_info_cache_clear();
556
557
558
}

/**
559
560
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
561
562
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
563
564
565
566
567
568
569
570
571
572
 * Used for items entered by administrators, like field descriptions, allowed
 * values, where some (mainly inline) mark-up may be desired (so
 * drupal_htmlspecialchars() is not acceptable).
 *
 * @param $string
 *   The string with raw HTML in it.
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not valid
 *   UTF-8.
573
574
 */
function field_filter_xss($string) {
575
  return _filter_htmlcorrector(filter_xss($string, _field_filter_xss_allowed_tags()));
576
577
578
}

/**
579
 * Returns a list of tags allowed by field_filter_xss().
580
581
582
583
584
585
 */
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');
}

/**
586
 * Returns a human-readable list of allowed tags for display in help texts.
587
588
589
590
591
592
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
593
 * Returns a renderable array for a single field value.
594
 *
595
 * @param \Drupal\Core\Entity\EntityInterface $entity
596
 *   The entity containing the field to display. Must at least contain the ID
597
598
599
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
600
 * @param $item
601
602
603
 *   The field value to display, as found in
 *   $entity->field_name[$langcode][$delta].
 * @param $display
604
605
 *   Can be either the name of a view mode, or an array of display settings. See
 *   field_view_field() for more information.
606
 * @param $langcode
607
608
609
 *   (Optional) The language of the value in $item. If not provided, the current
 *   language will be assumed.
 *
610
 * @return
611
 *   A renderable array for the field value.
612
 */
613
function field_view_value(EntityInterface $entity, $field_name, $item, $display = array(), $langcode = NULL) {
614
  $output = array();
615

616
617
618
  // Ensure we are working with a BC mode entity.
  $entity = $entity->getBCEntity();

619
  if ($field = field_info_field($entity->entityType(), $field_name)) {
620
    // Determine the langcode that will be used by language fallback.
621
    $langcode = field_language($entity, $field_name, $langcode);
622

623
624
625
626
    // 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);
627
    $elements = field_view_field($clone, $field_name, $display, $langcode);
628

629
630
631
632
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
633
634
    }
  }
635
636

  return $output;
637
638
639
}

/**
640
 * Returns a renderable array for the value of a single field in an entity.
641
 *
642
 * The resulting output is a fully themed field with label and multiple values.
643
 *
644
645
 * This function can be used by third-party modules that need to output an
 * isolated field.
646
 * - Do not use inside node (or any other entity) templates; use
647
 *   render($content[FIELD_NAME]) instead.
648
 * - Do not use to display all fields in an entity; use
649
 *   field_attach_prepare_view() and field_attach_view() instead.
650
651
 * - The field_view_value() function can be used to output a single formatted
 *   field value, without label or wrapping field markup.
652
 *
653
654
655
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
656
657
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity containing the field to display.
658
659
 * @param $field_name
 *   The name of the field to display.
660
 * @param $display_options
661
 *   Can be either:
662
663
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
664
665
666
 *     definition for the field in the entity's bundle. If no display settings
 *     are found for the view mode, the settings for the 'default' view mode
 *     will be used.
667
 *   - An array of display options. The following key/value pairs are allowed:
668
669
670
671
 *     - 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
672
673
 *       'default_formatter' for the field type. The default formatter will also
 *       be used if the requested formatter is not available.
674
 *     - settings: (array) Settings specific to the formatter. Defaults to the
675
 *       formatter's default settings.
676
677
678
 *     - weight: (float) The weight to assign to the renderable element.
 *       Defaults to 0.
 * @param $langcode
679
680
 *   (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
681
 *   available for the given language code. If no language code is provided the
682
 *   current language will be used.
683
 *
684
 * @return
685
 *   A renderable array for the field value.
686
687
 *
 * @see field_view_value()
688
 */
689
function field_view_field(EntityInterface $entity, $field_name, $display_options = array(), $langcode = NULL) {
690
  $output = array();
691
  $bundle = $entity->bundle();
692
  $entity_type = $entity->entityType();
693

694
  // Return nothing if the field doesn't exist.
695
  $instance = field_info_instance($entity_type, $field_name, $bundle);
696
697
698
699
700
701
702
  if (!$instance) {
    return $output;
  }

  // Get the formatter object.
  if (is_string($display_options)) {
    $view_mode = $display_options;
703
    $formatter = entity_get_render_display($entity, $view_mode)->getRenderer($field_name);
704
705
706
707
708
  }
  else {
    $view_mode = '_custom';
    // hook_field_attach_display_alter() needs to receive the 'prepared'
    // $display_options, so we cannot let preparation happen internally.
709
    $field = field_info_field($entity_type, $field_name);
710
711
712
    $formatter_manager = drupal_container()->get('plugin.manager.field.formatter');
    $display_options = $formatter_manager->prepareConfiguration($field['type'], $display_options);
    $formatter = $formatter_manager->getInstance(array(
713
      'field_definition' => $instance,
714
715
716
717
718
719
720
      'view_mode' => $view_mode,
      'prepare' => FALSE,
      'configuration' => $display_options,
    ));
  }

  if ($formatter) {
721
    $display_langcode = field_language($entity, $field_name, $langcode);
722

723
    // Invoke the formatter's prepareView() and view() methods.
724
    $items = $entity->getNGEntity()->getTranslation($display_langcode)->get($field_name);
725
    $id = $entity->id();
726
727
    $formatter->prepareView(array($id => $entity), $display_langcode, array($id => $items));
    $result = $formatter->view($entity, $display_langcode, $items);
728

729
730
731
732
733
734
    // Invoke hook_field_attach_view_alter() to let other modules alter the
    // renderable array, as in a full field_attach_view() execution.
    $context = array(
      'entity' => $entity,
      'view_mode' => $view_mode,
      'display_options' => $display_options,
735
      'langcode' => $display_langcode,
736
737
    );
    drupal_alter('field_attach_view', $result, $context);
738

739
740
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
741
    }
742
  }
743

744
745
746
747
  return $output;
}

/**
748
 * Determines whether the user has access to a given field.
749
 *
750
 * @param string $op
751
 *   The operation to be performed. Possible values:
752
753
 *   - edit
 *   - view
754
755
 * @param \Drupal\field\FieldInterface $field
 *   The field on which the operation is to be performed.
756
757
 * @param $entity_type
 *   The type of $entity; for example, 'node' or 'user'.
758
 * @param $entity
759
 *   (optional) The entity for the operation.
760
761
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
762
 *
763
 * @return
764
 *   TRUE if the operation is allowed; FALSE if the operation is denied.
765
 */
766
function field_access($op, FieldInterface $field, $entity_type, $entity = NULL, $account = NULL) {
767
768
  global $user;

769
  if (!isset($account)) {
770
771
772
    $account = $user;
  }

773
  foreach (Drupal::moduleHandler()->getImplementations('field_access') as $module) {
774
    $function = $module . '_field_access';
775
    $access = $function($op, $field, $entity_type, $entity, $account);
776
    if ($access === FALSE) {
777
778
779
780
781
782
      return FALSE;
    }
  }
  return TRUE;
}

783
/**
784
 * Extracts the bundle name from a bundle object.
785
 *
786
 * @param $entity_type
787
 *   The type of $entity; e.g., 'node' or 'user'.
788
 * @param $bundle
789
 *   The bundle object (or string if bundles for this entity type do not exist
790
 *   as standalone objects).
791
 *
792
793
794
 * @return
 *   The bundle name.
 */
795
function field_extract_bundle($entity_type, $bundle) {
796
797
798
799
  if (is_string($bundle)) {
    return $bundle;
  }

800
  $info = entity_get_info($entity_type);
801
802
  if (is_object($bundle) && isset($info['bundle_keys']['bundle']) && isset($bundle->{$info['bundle_keys']['bundle']})) {
    return $bundle->{$info['bundle_keys']['bundle']};
803
804
805
  }
}

806
807
808
809
810
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
811
  $page['#attached']['css'][$path . '/css/field.module.css'] = array('every_page' => TRUE);
812
813
}

814
/**
815
 * Prepares variables for field templates.
816
 *
817
818
819
820
821
822
823
824
825
 * Default template: field.html.twig.
 *
 * @param array $variables
 *   An associative array containing:
 *   - element: A render element representing the field.
 *   - attributes: A string containing the attributes for the wrapping div.
 *   - title_attributes: A string containing the attributes for the title.
 *   - content_attributes: A string containing the attributes for the content's
 *     div.
826
 */
827
function template_preprocess_field(&$variables, $hook) {
828
829
  $element = $variables['element'];

830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
  // 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().
854
  $variables['entity_type_css'] = strtr($element['#entity_type'], '_', '-');
855
856
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
857
  $variables['attributes']['class'] = array(
858
    'field',
859
    'field-' . $variables['entity_type_css'] . '--' . $variables['field_name_css'],
860
861
862
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
863
  );
864
  // Add a "clearfix" class to the wrapper since we float the label and the
865
  // field items in field.module.css if the label is inline.
866
  if ($element['#label_display'] == 'inline') {
867
    $variables['attributes']['class'][] = 'clearfix';
868
  }
869

870
871
  // Add specific suggestions that can override the default implementation.
  $variables['theme_hook_suggestions'] = array(
872
    'field__' . $element['#field_type'],
873
    'field__' . $element['#field_name'],
874
875
876
    'field__' . $element['#entity_type'] . '__' . $element['#bundle'],
    'field__' . $element['#entity_type'] . '__' . $element['#field_name'],
    'field__' . $element['#entity_type'] . '__' . $element['#field_name'] . '__' . $element['#bundle'],
877
  );
878

879
880
  static $default_attributes;
  if (!isset($default_attributes)) {
881
    $default_attributes = new Attribute;
882
  }
883
884
885
886
887
888
889
  // The default theme implementation for fields is a function.
  // template_preprocess() (which initializes the attributes, title_attributes,
  // and content_attributes arrays) does not run for theme function
  // implementations. Additionally, Attribute objects for the three variables
  // below only get instantiated for template file implementations, and we need
  // Attribute objects for printing in both theme functions and template files.
  // For best performance, we only instantiate Attribute objects when needed.
890
891
892
  $variables['attributes'] = isset($variables['attributes']) ? new Attribute($variables['attributes']) : clone $default_attributes;
  $variables['title_attributes'] = isset($variables['title_attributes']) ? new Attribute($variables['title_attributes']) : clone($default_attributes);
  $variables['content_attributes'] = isset($variables['content_attributes']) ? new Attribute($variables['content_attributes']) : clone($default_attributes);
893
  foreach ($variables['items'] as $delta => $item) {
894
    $variables['item_attributes'][$delta] = isset($variables['item_attributes'][$delta]) ? new Attribute($variables['item_attributes'][$delta]) : clone($default_attributes);
895
896
  }
}
897

898
/**
899
 * @} End of "defgroup field".
900
 */
901
902

/**
903
 * Returns HTML for a field.
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 *
 * 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
918
919
 * functions may copy the "field.html.twig" from the "modules/field/theme"
 * folder of the Drupal installation to somewhere within the theme's folder and
920
 * customize it, just like customizing other Drupal templates such as
921
 * page.html.twig or node.html.twig. However, it takes longer for the server to
922
923
 * 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.
924
 * For these websites, developers are discouraged from placing a field.html.twig
925
926
927
928
 * 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:
929
930
931
932
 * - field--body--article.html.twig
 * - field--article.html.twig
 * - field--body.html.twig
 * - field.html.twig
933
 * So, if the body field on the article content type needs customization, a
934
 * field--body--article.html.twig file can be added within the theme's folder.
935
 * Because it's a template, it will result in slightly more time needed to
936
937
 * 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
938
939
940
941
942
943
 * 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.
 *
944
945
 * @param $variables
 *   An associative array containing:
946
947
 *   - label_hidden: A boolean indicating whether to show or hide the field
 *     label.
948
949
 *   - title_attributes: A string containing the attributes for the title.
 *   - label: The label for the field.
950
 *   - content_attributes: A string containing the attributes for the content's
951
952
953
954
955
956
 *     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.
 *
957
 * @see template_preprocess_field()
958
 * @see field.html.twig
959
960
961
962
963
964
965
966
 *
 * @ingroup themeable
 */
function theme_field($variables) {
  $output = '';

  // Render the label, if it's not hidden.
  if (!$variables['label_hidden']) {
967
    $output .= '<div class="field-label"' . $variables['title_attributes'] . '>' . $variables['label'] . '</div>';
968
969
970
971
972
973
974
975
976
977
978
  }

  // 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.
979
  $output = '<div' . $variables['attributes'] . '>' . $output . '</div>';
980
981
982

  return $output;
}
983
984
985
986
987
988
989
990

/**
 * Assembles a partial entity structure with initial IDs.
 *
 * @param stdClass $ids
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
991
 * @return \Drupal\Core\Entity\EntityInterface
992
993
994
995
996
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
  $info = entity_get_info($ids->entity_type);
997
998
999
  if (isset($info['entity_keys']['id'])) {
    $id_properties[$info['entity_keys']['id']] = $ids->entity_id;
  }
1000
1001
  if (!empty($info['entity_keys']['revision']) && isset($ids->revision_id)) {
    $id_properties[$info['entity_keys']['revision']] = $ids->revision_id;
1002
  }
1003
1004
  if (!empty($info['entity_keys']['bundle']) && isset($ids->bundle)) {
    $id_properties[$info['entity_keys']['bundle']] = $ids->bundle;
1005
1006
  }
  return entity_create($ids->entity_type, $id_properties);
1007
1008
}

1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
/**
 * Implements hook_hook_info().
 */
function field_hook_info() {
  $hooks['field_views_data'] = array(
    'group' => 'views',
  );
  $hooks['field_views_data_alter'] = array(
    'group' => 'views',
  );

  return $hooks;
}