field.module 37.8 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
 * - @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_purge Field API bulk data deletion @endlink: Cleans up after
73
 *   bulk deletion operations such as deletion of field or field_instance.
74 75
 *
 * - @link field_language Field language API @endlink: Provides native
76
 *   multilingual support for the Field API.
77 78 79
 */

/**
80
 * Value for field API indicating a field accepts an unlimited number of values.
81
 */
82
const FIELD_CARDINALITY_UNLIMITED = -1;
83 84

/**
85 86 87
 * Value for field API indicating a widget doesn't accept default values.
 *
 * @see hook_field_widget_info()
88
 */
89
const FIELD_BEHAVIOR_NONE = 0x0001;
90

91
/**
92 93 94 95 96 97 98 99
 * 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.
100
 */
101
const FIELD_BEHAVIOR_DEFAULT = 0x0002;
102

103
/**
104 105 106
 * Value for field API indicating a widget can receive several field values.
 *
 * @see hook_field_widget_info()
107
 */
108
const FIELD_BEHAVIOR_CUSTOM = 0x0004;
109 110

/**
111
 * Implements hook_help().
112 113 114 115
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
116 117
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
118
      $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>';
119 120 121
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
122
      $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')));
123 124 125 126 127

      // 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');
128
      $modules = array_merge(Drupal::moduleHandler()->getImplementations('field_info'), Drupal::moduleHandler()->getImplementations('field_widget_info'));
129 130 131 132
      $modules = array_unique($modules);
      sort($modules);
      foreach ($modules as $module) {
        $display = $info[$module]['name'];
133
        if (Drupal::moduleHandler()->implementsHook($module, 'help')) {
134 135 136 137 138 139
          $items['items'][] = l($display, 'admin/help/' . $module);
        }
        else {
          $items['items'][] = $display;
        }
      }
140 141 142 143
      $item_list = array(
        '#theme' => 'item_list',
        '#items' => $items['items'],
      );
144
      $output .= drupal_render($item_list);
145 146 147 148 149
      return $output;
  }
}

/**
150
 * Implements hook_theme().
151 152
 */
function field_theme() {
153
  return array(
154
    'field' => array(
155
      'render element' => 'element',
156 157
    ),
    'field_multiple_value_form' => array(
158
      'render element' => 'element',
159 160 161 162
    ),
  );
}

163
/**
164
 * Implements hook_cron().
165 166
 */
function field_cron() {
167
  // Refresh the 'active' status of fields.
168
  field_sync_field_status();
169 170

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

175
/**
176 177
 * Implements hook_system_info_alter().
 *
178
 * Goes through a list of all modules that provide a field type and makes them
179
 * required if there are any active fields of that type.
180
 */
181
function field_system_info_alter(&$info, $file, $type) {
182
  // It is not safe to call field_read_fields() during maintenance mode.
183
  if ($type == 'module' && !defined('MAINTENANCE_MODE')) {
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
    $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')) {
199
          $explanation = t('Field type(s) in use - see <a href="@fields-page">Field list</a>', array('@fields-page' => url('admin/reports/fields')));
200 201 202 203 204 205 206 207 208 209
        }
        else {
          $explanation = t('Fields type(s) in use');
        }
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
210 211 212
  }
}

213 214 215 216 217 218 219 220 221 222
/**
 * 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) {
223
      $definition = _field_generate_entity_field_definition($instance->getField());
224

225 226 227 228 229 230
      if ($optional) {
        $property_info['optional'][$field_name] = $definition;
        $property_info['bundle map'][$bundle_name][] = $field_name;
      }
      else {
        $property_info['definitions'][$field_name] = $definition;
231 232 233 234 235 236 237
      }
    }
  }

  return $property_info;
}

238 239 240 241 242 243 244 245 246 247 248 249 250 251
/**
 * 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(
252
    'label' => t('Field !name', array('!name' => $field->name)),
253 254 255 256 257 258 259 260 261 262 263 264
    'type' => 'field_item:' . $field->type,
    'list' => TRUE,
    'configurable' => TRUE,
    'translatable' => !empty($field->translatable),
  );
  if ($instance) {
    $definition['instance'] = $instance;
  }

  return $definition;
}

265 266 267 268 269
/**
 * Implements hook_field_widget_info_alter().
 */
function field_field_widget_info_alter(&$info) {
  // Add the Hidden widget to all field types.
270
  $info['hidden']['field_types'] = array_keys(\Drupal::service('plugin.manager.entity.field.field_type')->getDefinitions());
271 272
}

273
/**
274
 * Implements hook_entity_bundle_create().
275
 */
276 277 278 279
function field_entity_bundle_create($entity_type, $bundle) {
  // Clear the cache.
  field_cache_clear();
}
280

281 282 283 284 285 286 287 288 289 290 291 292
/**
 * 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();
293 294
    }
  }
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328

  // 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);
329 330
}

331 332 333 334
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
335
  // Refresh the 'active' status of fields.
336 337 338
  field_sync_field_status();
}

339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
/**
 * 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();
}

355
/**
356
 * Refreshes the 'active' and 'storage[active]' values for fields.
357 358
 */
function field_sync_field_status() {
359 360 361 362 363
  $module_handler = Drupal::moduleHandler();
  $state = Drupal::state();

  // Get both deleted and non-deleted field definitions.
  $fields = array();
364
  foreach (config_get_storage_names_with_prefix('field.field.') as $name) {
365 366
    $field = Drupal::config($name)->get();
    $fields[$field['uuid']] = $field;
367
  }
368 369
  $deleted_fields = $state->get('field.field.deleted') ?: array();
  $fields += $deleted_fields;
370

371 372
  if (empty($fields)) {
    return;
373
  }
374 375 376 377 378

  // Set the 'module' and 'active' values for the current set of enabled
  // modules.
  $changed = array();
  $modules = $module_handler->getModuleList();
379
  $field_types = Drupal::service('plugin.manager.entity.field.field_type')->getDefinitions();
380
  // Set fields with missing field type modules to inactive.
381
  foreach ($fields as $uuid => &$field) {
382
    // Associate field types.
383 384
    if (isset($field_types[$field['type']]) && ($field['module'] != $field_types[$field['type']]['provider'] || !$field['active'])) {
      $field['module'] = $field_types[$field['type']]['provider'];
385 386 387
      $field['active'] = TRUE;
      $changed[$uuid] = $field;
    }
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
    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();
409 410
}

411
/**
412 413
 * Gets or sets administratively defined bundle settings.
 *
414
 * @param string $entity_type
415
 *   The type of $entity; e.g., 'node' or 'user'.
416
 * @param string $bundle
417
 *   The bundle name.
418 419 420 421 422
 * @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:
423 424 425
 *     - status: Boolean specifying whether the view mode uses a dedicated set
 *       of display options (TRUE), or the 'default' options (FALSE). Defaults
 *       to FALSE.
426 427 428 429 430 431 432 433 434 435 436 437 438
 *   - 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.
439
 *
440
 * @return array|null
441 442 443 444
 *   If no $settings are passed, the current settings are returned.
 */
function field_bundle_settings($entity_type, $bundle, $settings = NULL) {
  if (isset($settings)) {
445
    variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle, $settings);
446
    field_info_cache_clear();
447 448
  }
  else {
449
    $settings = variable_get('field_bundle_settings_' . $entity_type . '__' . $bundle, array());
450 451
    $settings += array(
      'view_modes' => array(),
452
      'form_modes' => array(),
453
    );
454 455 456 457 458

    return $settings;
  }
}

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
/**
 * 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];
}

494 495 496 497 498 499 500 501 502 503
/**
 * 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:
504 505 506
 *   - status: Boolean specifying whether the view mode uses a dedicated set of
 *     display options (TRUE), or the 'default' options (FALSE). Defaults to
 *     FALSE.
507 508 509 510 511 512 513 514
 */
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
515 516
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
517 518
    $view_modes = entity_get_view_modes($entity_type);
    foreach ($view_modes as $view_mode => $view_mode_info) {
519 520
      if (!isset($settings[$view_mode]['status']) && $view_mode_info['status']) {
        $settings[$view_mode]['status'] = TRUE;
521 522 523 524 525 526 527 528
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

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

529
/**
530
 * Clears the field info and field data caches.
531
 */
532
function field_cache_clear() {
533
  cache('field')->deleteAll();
534
  field_info_cache_clear();
535 536 537
}

/**
538 539
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
540 541
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
542 543 544 545 546 547 548 549 550 551
 * 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.
552 553
 */
function field_filter_xss($string) {
554
  return _filter_htmlcorrector(filter_xss($string, _field_filter_xss_allowed_tags()));
555 556 557
}

/**
558
 * Returns a list of tags allowed by field_filter_xss().
559 560 561 562 563 564
 */
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');
}

/**
565
 * Returns a human-readable list of allowed tags for display in help texts.
566 567 568 569 570 571
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

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

595 596 597
  // Ensure we are working with a BC mode entity.
  $entity = $entity->getBCEntity();

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

602 603 604 605
    // 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);
606
    $elements = field_view_field($clone, $field_name, $display, $langcode);
607

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

  return $output;
616 617 618
}

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

673
  // Return nothing if the field doesn't exist.
674
  $instance = field_info_instance($entity_type, $field_name, $bundle);
675 676 677 678 679 680 681
  if (!$instance) {
    return $output;
  }

  // Get the formatter object.
  if (is_string($display_options)) {
    $view_mode = $display_options;
682
    $formatter = entity_get_render_display($entity, $view_mode)->getRenderer($field_name);
683 684 685 686 687
  }
  else {
    $view_mode = '_custom';
    // hook_field_attach_display_alter() needs to receive the 'prepared'
    // $display_options, so we cannot let preparation happen internally.
688
    $field = field_info_field($entity_type, $field_name);
689 690 691
    $formatter_manager = drupal_container()->get('plugin.manager.field.formatter');
    $display_options = $formatter_manager->prepareConfiguration($field['type'], $display_options);
    $formatter = $formatter_manager->getInstance(array(
692
      'field_definition' => $instance,
693 694 695 696 697 698 699
      'view_mode' => $view_mode,
      'prepare' => FALSE,
      'configuration' => $display_options,
    ));
  }

  if ($formatter) {
700
    $display_langcode = field_language($entity, $field_name, $langcode);
701

702
    // Invoke the formatter's prepareView() and view() methods.
703
    $items = $entity->getNGEntity()->getTranslation($display_langcode)->get($field_name);
704
    $id = $entity->id();
705 706
    $formatter->prepareView(array($id => $entity), $display_langcode, array($id => $items));
    $result = $formatter->view($entity, $display_langcode, $items);
707

708 709 710 711 712 713
    // 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,
714
      'langcode' => $display_langcode,
715 716
    );
    drupal_alter('field_attach_view', $result, $context);
717

718 719
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
720
    }
721
  }
722

723 724 725 726
  return $output;
}

/**
727
 * Determines whether the user has access to a given field.
728
 *
729
 * @param string $op
730
 *   The operation to be performed. Possible values:
731 732
 *   - edit
 *   - view
733 734
 * @param \Drupal\field\FieldInterface $field
 *   The field on which the operation is to be performed.
735 736
 * @param $entity_type
 *   The type of $entity; for example, 'node' or 'user'.
737
 * @param $entity
738
 *   (optional) The entity for the operation.
739 740
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
741
 *
742
 * @return
743
 *   TRUE if the operation is allowed; FALSE if the operation is denied.
744
 */
745
function field_access($op, FieldInterface $field, $entity_type, $entity = NULL, $account = NULL) {
746 747
  global $user;

748
  if (!isset($account)) {
749 750 751
    $account = $user;
  }

752
  foreach (Drupal::moduleHandler()->getImplementations('field_access') as $module) {
753
    $function = $module . '_field_access';
754
    $access = $function($op, $field, $entity_type, $entity, $account);
755
    if ($access === FALSE) {
756 757 758 759 760 761
      return FALSE;
    }
  }
  return TRUE;
}

762
/**
763
 * Extracts the bundle name from a bundle object.
764
 *
765
 * @param $entity_type
766
 *   The type of $entity; e.g., 'node' or 'user'.
767
 * @param $bundle
768
 *   The bundle object (or string if bundles for this entity type do not exist
769
 *   as standalone objects).
770
 *
771 772 773
 * @return
 *   The bundle name.
 */
774
function field_extract_bundle($entity_type, $bundle) {
775 776 777 778
  if (is_string($bundle)) {
    return $bundle;
  }

779
  $info = entity_get_info($entity_type);
780 781
  if (is_object($bundle) && isset($info['bundle_keys']['bundle']) && isset($bundle->{$info['bundle_keys']['bundle']})) {
    return $bundle->{$info['bundle_keys']['bundle']};
782 783 784
  }
}

785 786 787 788 789
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
790
  $page['#attached']['css'][$path . '/css/field.module.css'] = array('every_page' => TRUE);
791 792
}

793
/**
794
 * Prepares variables for field templates.
795
 *
796 797 798 799 800 801 802 803 804
 * 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.
805
 */
806
function template_preprocess_field(&$variables, $hook) {
807 808
  $element = $variables['element'];

809 810 811 812 813 814 815 816 817 818 819
  // 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
820 821 822 823
  // (deltas) should always be numerically indexed starting from 0, 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.
824
  $variables['items'] = array();
825 826 827 828
  $delta = 0;
  while (!empty($element[$delta])) {
    $variables['items'][$delta] = $element[$delta];
    $delta++;
829 830 831 832 833
  }

  // 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().
834
  $variables['entity_type_css'] = strtr($element['#entity_type'], '_', '-');
835 836
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
837
  $variables['attributes']['class'] = array(
838
    'field',
839
    'field-' . $variables['entity_type_css'] . '--' . $variables['field_name_css'],
840 841 842
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
843
  );
844
  // Add a "clearfix" class to the wrapper since we float the label and the
845
  // field items in field.module.css if the label is inline.
846
  if ($element['#label_display'] == 'inline') {
847
    $variables['attributes']['class'][] = 'clearfix';
848
  }
849

850 851
  // Add specific suggestions that can override the default implementation.
  $variables['theme_hook_suggestions'] = array(
852
    'field__' . $element['#field_type'],
853
    'field__' . $element['#field_name'],
854 855 856
    'field__' . $element['#entity_type'] . '__' . $element['#bundle'],
    'field__' . $element['#entity_type'] . '__' . $element['#field_name'],
    'field__' . $element['#entity_type'] . '__' . $element['#field_name'] . '__' . $element['#bundle'],
857
  );
858

859 860
  static $default_attributes;
  if (!isset($default_attributes)) {
861
    $default_attributes = new Attribute;
862
  }
863 864 865 866 867 868 869
  // 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.
870 871 872
  $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);
873
  foreach ($variables['items'] as $delta => $item) {
874
    $variables['item_attributes'][$delta] = isset($variables['item_attributes'][$delta]) ? new Attribute($variables['item_attributes'][$delta]) : clone($default_attributes);
875 876
  }
}
877

878
/**
879
 * @} End of "defgroup field".
880
 */
881 882

/**
883
 * Returns HTML for a field.
884 885 886 887 888 889 890 891 892 893 894 895 896 897
 *
 * 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
898 899
 * 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
900
 * customize it, just like customizing other Drupal templates such as
901
 * page.html.twig or node.html.twig. However, it takes longer for the server to
902 903
 * 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.
904
 * For these websites, developers are discouraged from placing a field.html.twig
905 906 907 908
 * 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:
909 910 911 912
 * - field--body--article.html.twig
 * - field--article.html.twig
 * - field--body.html.twig
 * - field.html.twig
913
 * So, if the body field on the article content type needs customization, a
914
 * field--body--article.html.twig file can be added within the theme's folder.
915
 * Because it's a template, it will result in slightly more time needed to
916 917
 * 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
918 919 920 921 922 923
 * 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.
 *
924 925
 * @param $variables
 *   An associative array containing:
926 927
 *   - label_hidden: A boolean indicating whether to show or hide the field
 *     label.
928 929
 *   - title_attributes: A string containing the attributes for the title.
 *   - label: The label for the field.
930
 *   - content_attributes: A string containing the attributes for the content's
931 932 933 934 935 936
 *     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.
 *
937
 * @see template_preprocess_field()
938
 * @see field.html.twig
939 940 941 942 943 944 945 946
 *
 * @ingroup themeable
 */
function theme_field($variables) {
  $output = '';

  // Render the label, if it's not hidden.
  if (!$variables['label_hidden']) {
947
    $output .= '<div class="field-label"' . $variables['title_attributes'] . '>' . $variables['label'] . '</div>';
948 949 950 951 952 953 954 955 956 957 958
  }

  // 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.
959
  $output = '<div' . $variables['attributes'] . '>' . $output . '</div>';
960 961 962

  return $output;
}
963 964 965 966 967 968 969 970

/**
 * 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).
 *
971
 * @return \Drupal\Core\Entity\EntityInterface
972 973 974 975 976
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
  $info = entity_get_info($ids->entity_type);
977 978 979
  if (isset($info['entity_keys']['id'])) {
    $id_properties[$info['entity_keys']['id']] = $ids->entity_id;
  }
980 981
  if (!empty($info['entity_keys']['revision']) && isset($ids->revision_id)) {
    $id_properties[$info['entity_keys']['revision']] = $ids->revision_id;
982
  }
983 984
  if (!empty($info['entity_keys']['bundle']) && isset($ids->bundle)) {
    $id_properties[$info['entity_keys']['bundle']] = $ids->bundle;
985 986
  }
  return entity_create($ids->entity_type, $id_properties);
987 988
}

989 990 991 992 993 994 995 996 997 998 999 1000 1001
/**
 * 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;
}