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

7
use Drupal\Core\Entity\ContentEntityInterface;
8
use Drupal\Core\Entity\EntityInterface;
9
use Drupal\Core\Template\Attribute;
10

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

22 23 24
/**
 * @defgroup field Field API
 * @{
25 26 27 28 29 30 31 32
 * 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.
33
 *
34 35 36 37 38 39 40 41 42 43 44 45
 * 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
46
 * node storage controller loads an Article node, it loads the values of the
47 48
 * 'subtitle' and 'photo' fields because they are both attached to the 'node'
 * bundle 'article'.
49
 *
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
 * - @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
70
 *   bulk deletion operations such as deletion of field or field_instance.
71 72
 *
 * - @link field_language Field language API @endlink: Provides native
73
 *   multilingual support for the Field API.
74 75 76
 */

/**
77
 * Implements hook_help().
78 79 80 81
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
82 83
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
84
      $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>';
85 86 87
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
88
      $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')));
89

90 91
      // Make a list of all widget and field modules currently enabled, ordered
      // by displayed module name (module names are not translated).
92 93
      $items = array();
      $info = system_get_info('module');
94
      $field_widgets = \Drupal::service('plugin.manager.field.widget')->getDefinitions();
95
      $field_types = \Drupal::service('plugin.manager.field.field_type')->getConfigurableDefinitions();
96 97
      foreach (array_merge($field_types, $field_widgets) as $plugin) {
        $providers[] = $plugin['provider'];
98
      }
99 100 101 102 103 104 105 106 107 108 109 110 111
      $providers = array_unique($providers);
      sort($providers);
      foreach ($providers as $provider) {
        // Skip plugins provided by core components as they do not implement
        // hook_help().
        if (isset($info[$provider]['name'])) {
          $display = $info[$provider]['name'];
          if (\Drupal::moduleHandler()->implementsHook($provider, 'help')) {
            $items[] = l($display, 'admin/help/' . $provider);
          }
          else {
            $items[] = $display;
          }
112 113
        }
      }
114 115
      $item_list = array(
        '#theme' => 'item_list',
116
        '#items' => $items,
117
      );
118
      $output .= drupal_render($item_list);
119 120 121 122 123
      return $output;
  }
}

/**
124
 * Implements hook_theme().
125 126
 */
function field_theme() {
127
  return array(
128
    'field' => array(
129
      'render element' => 'element',
130 131
    ),
    'field_multiple_value_form' => array(
132
      'render element' => 'element',
133 134 135 136
    ),
  );
}

137
/**
138
 * Implements hook_cron().
139 140
 */
function field_cron() {
141
  // Do a pass of purging on deleted Field API data, if any exists.
142
  $limit = \Drupal::config('field.settings')->get('purge_batch_size');
143 144 145
  field_purge_batch($limit);
}

146
/**
147 148
 * Implements hook_system_info_alter().
 *
149
 * Goes through a list of all modules that provide a field type and makes them
150
 * required if there are any active fields of that type.
151
 */
152
function field_system_info_alter(&$info, $file, $type) {
153 154
  // It is not safe to call entity_load_multiple_by_properties() during
  // maintenance mode.
155
  if ($type == 'module' && !defined('MAINTENANCE_MODE')) {
156
    $fields = entity_load_multiple_by_properties('field_entity', array('module' => $file->name, 'include_deleted' => TRUE));
157 158 159 160 161 162 163
    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) {
164
        if (empty($field->deleted)) {
165 166 167 168 169
          $non_deleted = TRUE;
          break;
        }
      }
      if ($non_deleted) {
170
        if (\Drupal::moduleHandler()->moduleExists('field_ui')) {
171
          $explanation = t('Field type(s) in use - see <a href="@fields-page">Field list</a>', array('@fields-page' => url('admin/reports/fields')));
172 173 174 175 176 177 178 179 180 181
        }
        else {
          $explanation = t('Fields type(s) in use');
        }
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
182 183 184
  }
}

185 186 187 188 189 190 191 192
/**
 * 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;
193 194 195
    // @todo: Improve hook_entity_field_info() to allow per-bundle field
    // definitions, such that we can pass on field instances as field
    // definitions here. See https://drupal.org/node/2114707.
196 197

    foreach ($instances as $field_name => $instance) {
198
      if ($optional) {
199
        $property_info['optional'][$field_name] = $instance->getField();
200 201 202
        $property_info['bundle map'][$bundle_name][] = $field_name;
      }
      else {
203
        $property_info['definitions'][$field_name] = $instance->getField();
204 205 206 207 208 209 210
      }
    }
  }

  return $property_info;
}

211
/**
212
 * Implements hook_entity_bundle_create().
213
 */
214 215 216 217
function field_entity_bundle_create($entity_type, $bundle) {
  // Clear the cache.
  field_cache_clear();
}
218

219 220 221 222
/**
 * Implements hook_entity_bundle_rename().
 */
function field_entity_bundle_rename($entity_type, $bundle_old, $bundle_new) {
223
  $instances = entity_load_multiple_by_properties('field_instance', array('entity_type' => $entity_type, 'bundle' => $bundle_old));
224 225
  foreach ($instances as $instance) {
    if ($instance->entity_type == $entity_type && $instance->bundle == $bundle_old) {
226
      $id_new = $instance->entity_type . '.' . $bundle_new . '.' . $instance->field_name;
227 228 229 230
      $instance->id = $id_new;
      $instance->bundle = $bundle_new;
      $instance->allowBundleRename();
      $instance->save();
231 232
    }
  }
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

  // Clear the field cache.
  field_cache_clear();
}

/**
 * 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) {
249 250 251 252
  // Get the instances on the bundle. entity_load_multiple_by_properties() must
  // be used here since field_info_instances() does not return instances for
  // disabled entity types or bundles.
  $instances = entity_load_multiple_by_properties('field_instance', array('entity_type' => $entity_type, 'bundle' => $bundle));
253 254 255 256 257 258
  foreach ($instances as $instance) {
    $instance->delete();
  }

  // Clear the cache.
  field_cache_clear();
259 260
}

261 262 263 264
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
265
  field_cache_clear();
266 267
}

268
/**
269
 * Implements hook_modules_installed().
270
 */
271
function field_modules_installed($modules) {
272
  field_cache_clear();
273 274 275
}

/**
276
 * Implements hook_modules_uninstalled().
277
 */
278
function field_modules_uninstalled($modules) {
279
  field_cache_clear();
280 281 282
}

/**
283
 * Clears the field info and field data caches.
284
 */
285
function field_cache_clear() {
286
  cache('field')->deleteAll();
287
  field_info_cache_clear();
288 289 290
}

/**
291 292
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
293 294
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
295 296 297 298 299 300 301 302 303 304
 * 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.
305 306
 */
function field_filter_xss($string) {
307
  return _filter_htmlcorrector(filter_xss($string, _field_filter_xss_allowed_tags()));
308 309 310
}

/**
311
 * Returns a list of tags allowed by field_filter_xss().
312 313 314 315 316 317
 */
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');
}

/**
318
 * Returns a human-readable list of allowed tags for display in help texts.
319 320 321 322 323 324
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
325
 * Returns a renderable array for a single field value.
326
 *
327
 * @param \Drupal\Core\Entity\EntityInterface $entity
328
 *   The entity containing the field to display. Must at least contain the ID
329 330 331
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
332
 * @param $item
333
 *   The field item value to display.
334
 * @param $display
335 336
 *   Can be either the name of a view mode, or an array of display settings. See
 *   field_view_field() for more information.
337
 * @param $langcode
338 339 340
 *   (Optional) The language of the value in $item. If not provided, the current
 *   language will be assumed.
 *
341
 * @return
342
 *   A renderable array for the field value.
343
 */
344
function field_view_value(EntityInterface $entity, $field_name, $item, $display = array(), $langcode = NULL) {
345
  $output = array();
346

347
  if ($field = field_info_field($entity->getEntityTypeId(), $field_name)) {
348 349 350 351 352
    // Clone the entity since we are going to modify field values.
    $clone = clone $entity;

    // Apply language fallback.
    $clone = \Drupal::entityManager()->getTranslationFromContext($clone, $langcode);
353

354 355
    // 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.
356
    $clone->{$field_name}->setValue(array($item));
357
    $elements = field_view_field($clone, $field_name, $display, $langcode);
358

359 360 361 362
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
363 364
    }
  }
365 366

  return $output;
367 368 369
}

/**
370
 * Returns a renderable array for the value of a single field in an entity.
371
 *
372
 * The resulting output is a fully themed field with label and multiple values.
373
 *
374 375
 * This function can be used by third-party modules that need to output an
 * isolated field.
376
 * - Do not use inside node (or any other entity) templates; use
377
 *   render($content[FIELD_NAME]) instead.
378
 * - Do not use to display all fields in an entity; use
379
 *   field_attach_prepare_view() and field_attach_view() instead.
380 381
 * - The field_view_value() function can be used to output a single formatted
 *   field value, without label or wrapping field markup.
382
 *
383 384 385
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
386
 * @param \Drupal\Core\Entity\ContentEntityInterface $entity
387
 *   The entity containing the field to display.
388 389
 * @param $field_name
 *   The name of the field to display.
390
 * @param $display_options
391
 *   Can be either:
392 393
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
394 395 396
 *     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.
397
 *   - An array of display options. The following key/value pairs are allowed:
398 399 400 401
 *     - 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
402 403
 *       'default_formatter' for the field type. The default formatter will also
 *       be used if the requested formatter is not available.
404
 *     - settings: (array) Settings specific to the formatter. Defaults to the
405
 *       formatter's default settings.
406 407 408
 *     - weight: (float) The weight to assign to the renderable element.
 *       Defaults to 0.
 * @param $langcode
409 410
 *   (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
411
 *   available for the given language code. If no language code is provided the
412
 *   current language will be used.
413
 *
414
 * @return
415
 *   A renderable array for the field value.
416 417
 *
 * @see field_view_value()
418
 */
419
function field_view_field(ContentEntityInterface $entity, $field_name, $display_options = array(), $langcode = NULL) {
420
  $output = array();
421

422
  // Return nothing if the field doesn't exist.
423
  if (!$entity->hasField($field_name)) {
424 425
    return $output;
  }
426
  $field_definition = $entity->get($field_name)->getFieldDefinition();
427 428 429 430

  // Get the formatter object.
  if (is_string($display_options)) {
    $view_mode = $display_options;
431
    $formatter = entity_get_render_display($entity, $view_mode)->getRenderer($field_name);
432 433 434 435 436
  }
  else {
    $view_mode = '_custom';
    // hook_field_attach_display_alter() needs to receive the 'prepared'
    // $display_options, so we cannot let preparation happen internally.
437
    $formatter_manager = Drupal::service('plugin.manager.field.formatter');
438
    $display_options = $formatter_manager->prepareConfiguration($field_definition->getType(), $display_options);
439
    $formatter = $formatter_manager->getInstance(array(
440
      'field_definition' => $field_definition,
441 442 443 444 445 446 447
      'view_mode' => $view_mode,
      'prepare' => FALSE,
      'configuration' => $display_options,
    ));
  }

  if ($formatter) {
448 449 450
    // Apply language fallback.
    $entity = \Drupal::entityManager()->getTranslationFromContext($entity, $langcode);
    $items = $entity->get($field_name);
451

452
    // Run the formatter.
453 454
    $formatter->prepareView(array($entity->id() => $items));
    $result = $formatter->view($items);
455

456 457 458 459 460 461
    // 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,
462
      'langcode' => $entity->language()->id,
463 464
    );
    drupal_alter('field_attach_view', $result, $context);
465

466 467
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
468
    }
469
  }
470

471 472 473
  return $output;
}

474 475 476 477 478
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
479
  $page['#attached']['css'][$path . '/css/field.module.css'] = array('every_page' => TRUE);
480 481
}

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
/**
 * Implements hook_theme_suggestions_HOOK().
 */
function field_theme_suggestions_field(array $variables) {
  $suggestions = array();
  $element = $variables['element'];

  $suggestions[] = 'field__' . $element['#field_type'];
  $suggestions[] = 'field__' . $element['#field_name'];
  $suggestions[] = 'field__' . $element['#entity_type'] . '__' . $element['#bundle'];
  $suggestions[] = 'field__' . $element['#entity_type'] . '__' . $element['#field_name'];
  $suggestions[] = 'field__' . $element['#entity_type'] . '__' . $element['#field_name'] . '__' . $element['#bundle'];

  return $suggestions;
}

498
/**
499
 * Prepares variables for field templates.
500
 *
501 502 503 504 505 506 507 508 509
 * 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.
510
 */
511
function template_preprocess_field(&$variables, $hook) {
512 513
  $element = $variables['element'];

514 515 516 517 518 519 520
  // 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');
521
  $variables['label'] = check_plain($element['#title']);
522 523 524

  // We want other preprocess functions and the theme implementation to have
  // fast access to the field item render arrays. The item render array keys
525 526 527 528
  // (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.
529
  $variables['items'] = array();
530 531 532 533
  $delta = 0;
  while (!empty($element[$delta])) {
    $variables['items'][$delta] = $element[$delta];
    $delta++;
534 535 536 537 538
  }

  // 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().
539
  $variables['entity_type_css'] = strtr($element['#entity_type'], '_', '-');
540 541
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
542
  $variables['attributes']['class'] = array(
543
    'field',
544
    'field-' . $variables['entity_type_css'] . '--' . $variables['field_name_css'],
545 546 547
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
548
  );
549
  // Add a "clearfix" class to the wrapper since we float the label and the
550
  // field items in field.module.css if the label is inline.
551
  if ($element['#label_display'] == 'inline') {
552
    $variables['attributes']['class'][] = 'clearfix';
553
  }
554

555 556
  static $default_attributes;
  if (!isset($default_attributes)) {
557
    $default_attributes = new Attribute;
558
  }
559 560 561 562 563 564 565
  // 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.
566 567 568
  $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);
569 570 571 572 573 574 575 576

  // Modules (e.g., rdf.module) can add field item attributes (to
  // $item->_attributes) within hook_entity_prepare_view(). Some field
  // formatters move those attributes into some nested formatter-specific
  // element in order have them rendered on the desired HTML element (e.g., on
  // the <a> element of a field item being rendered as a link). Other field
  // formatters leave them within $element['#items'][$delta]['_attributes'] to
  // be rendered on the item wrappers provided by theme_field().
577
  foreach ($variables['items'] as $delta => $item) {
578
    $variables['item_attributes'][$delta] = !empty($element['#items'][$delta]->_attributes) ? new Attribute($element['#items'][$delta]->_attributes) : clone($default_attributes);
579 580
  }
}
581

582
/**
583
 * @} End of "defgroup field".
584
 */
585 586

/**
587
 * Returns HTML for a field.
588 589 590 591 592 593 594 595 596 597 598 599 600 601
 *
 * 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
602 603
 * 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
604
 * customize it, just like customizing other Drupal templates such as
605
 * page.html.twig or node.html.twig. However, it takes longer for the server to
606 607
 * 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.
608
 * For these websites, developers are discouraged from placing a field.html.twig
609 610 611 612
 * 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:
613 614 615 616
 * - field--body--article.html.twig
 * - field--article.html.twig
 * - field--body.html.twig
 * - field.html.twig
617
 * So, if the body field on the article content type needs customization, a
618
 * field--body--article.html.twig file can be added within the theme's folder.
619
 * Because it's a template, it will result in slightly more time needed to
620 621
 * 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
622 623 624 625 626 627
 * 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.
 *
628
 * @param array $variables
629
 *   An associative array containing:
630 631
 *   - label_hidden: A boolean indicating whether to show or hide the field
 *     label.
632 633
 *   - title_attributes: A string containing the attributes for the title.
 *   - label: The label for the field.
634
 *   - content_attributes: A string containing the attributes for the content's
635 636 637 638 639 640
 *     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.
 *
641
 * @see template_preprocess_field()
642
 * @see field.html.twig
643 644 645 646 647 648 649 650
 *
 * @ingroup themeable
 */
function theme_field($variables) {
  $output = '';

  // Render the label, if it's not hidden.
  if (!$variables['label_hidden']) {
651
    $output .= '<div class="field-label"' . $variables['title_attributes'] . '>' . $variables['label'] . '</div>';
652 653 654 655 656
  }

  // Render the items.
  $output .= '<div class="field-items"' . $variables['content_attributes'] . '>';
  foreach ($variables['items'] as $delta => $item) {
657
    $output .= '<div class="field-item"' . $variables['item_attributes'][$delta] . '>' . drupal_render($item) . '</div>';
658 659 660 661
  }
  $output .= '</div>';

  // Render the top-level DIV.
662
  $output = '<div' . $variables['attributes'] . '>' . $output . '</div>';
663 664 665

  return $output;
}
666 667 668 669

/**
 * Assembles a partial entity structure with initial IDs.
 *
670
 * @param object $ids
671 672 673
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
674
 * @return \Drupal\Core\Entity\EntityInterface
675 676 677 678
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
679 680 681
  $info = \Drupal::entityManager()->getDefinition($ids->entity_type);
  if ($id_key = $info->getKey('id')) {
    $id_properties[$id_key] = $ids->entity_id;
682
  }
683 684
  if (isset($ids->revision_id) && $revision_key = $info->getKey('revision')) {
    $id_properties[$revision_key] = $ids->revision_id;
685
  }
686 687
  if (isset($ids->bundle) && $bundle_key = $info->getKey('bundle')) {
    $id_properties[$bundle_key] = $ids->bundle;
688 689
  }
  return entity_create($ids->entity_type, $id_properties);
690 691
}

692 693 694 695 696 697 698 699 700 701 702 703 704
/**
 * 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;
}