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

7 8
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\Xss;
9
use Drupal\Core\Entity\ContentEntityInterface;
10
use Drupal\Core\Template\Attribute;
11
use Drupal\entity\Entity\EntityViewDisplay;
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
require_once __DIR__ . '/field.info.inc';
require_once __DIR__ . '/field.attach.inc';
require_once __DIR__ . '/field.form.inc';
21 22
require_once __DIR__ . '/field.purge.inc';
require_once __DIR__ . '/field.deprecated.inc';
23

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

/**
79
 * Implements hook_help().
80 81 82 83
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
84 85
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
86
      $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>';
87 88 89
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
90
      $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. The modules can be enabled from the <a href="@modules">Modules administration page</a>. Drupal core includes the following field type modules: Text, Number, Email, Link, Telephone, Image, File, Options, Taxonomy, and Entity Reference. 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>.', array('@modules' => url('admin/modules'), '@contrib' => 'http://drupal.org/project/modules', '@options' => url('admin/help/options')));
91

92 93
      // Make a list of all widget and field modules currently enabled, ordered
      // by displayed module name (module names are not translated).
94 95
      $items = array();
      $info = system_get_info('module');
96
      $field_widgets = \Drupal::service('plugin.manager.field.widget')->getDefinitions();
97
      $field_types = \Drupal::service('plugin.manager.field.field_type')->getConfigurableDefinitions();
98
      $providers = array();
99 100
      foreach (array_merge($field_types, $field_widgets) as $plugin) {
        $providers[] = $plugin['provider'];
101
      }
102 103 104 105 106 107 108 109 110 111 112 113 114
      $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;
          }
115 116
        }
      }
117 118 119 120 121 122 123 124
      if ($items) {
        $output .= ' ' . t('Currently enabled field and input widget modules:');
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $items,
        );
        $output .= drupal_render($item_list);
      }
125 126 127 128 129
      return $output;
  }
}

/**
130
 * Implements hook_theme().
131 132
 */
function field_theme() {
133
  return array(
134
    'field' => array(
135
      'render element' => 'element',
136 137
    ),
    'field_multiple_value_form' => array(
138
      'render element' => 'element',
139 140 141 142
    ),
  );
}

143
/**
144
 * Implements hook_cron().
145 146
 */
function field_cron() {
147
  // Do a pass of purging on deleted Field API data, if any exists.
148
  $limit = \Drupal::config('field.settings')->get('purge_batch_size');
149 150 151
  field_purge_batch($limit);
}

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

191 192 193 194 195 196 197 198
/**
 * 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;
199 200 201
    // @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.
202 203

    foreach ($instances as $field_name => $instance) {
204
      if ($optional) {
205
        $property_info['optional'][$field_name] = $instance->getField();
206 207 208
        $property_info['bundle map'][$bundle_name][] = $field_name;
      }
      else {
209
        $property_info['definitions'][$field_name] = $instance->getField();
210 211 212 213 214 215 216
      }
    }
  }

  return $property_info;
}

217
/**
218
 * Implements hook_entity_bundle_create().
219
 */
220 221 222 223
function field_entity_bundle_create($entity_type, $bundle) {
  // Clear the cache.
  field_cache_clear();
}
224

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

  // 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) {
255 256 257
  // 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.
258
  $instances = entity_load_multiple_by_properties('field_instance_config', array('entity_type' => $entity_type, 'bundle' => $bundle));
259 260 261 262 263 264
  foreach ($instances as $instance) {
    $instance->delete();
  }

  // Clear the cache.
  field_cache_clear();
265 266
}

267 268 269 270
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
271
  field_cache_clear();
272 273
}

274
/**
275
 * Implements hook_modules_installed().
276
 */
277
function field_modules_installed($modules) {
278
  field_cache_clear();
279 280 281
}

/**
282
 * Implements hook_modules_uninstalled().
283
 */
284
function field_modules_uninstalled($modules) {
285
  field_cache_clear();
286 287 288
}

/**
289
 * Clears the field info and field data caches.
290
 */
291
function field_cache_clear() {
292
  \Drupal::cache('field')->deleteAll();
293
  field_info_cache_clear();
294 295 296
}

/**
297 298
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
299 300
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
301 302 303 304 305 306 307 308 309 310
 * 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.
311 312
 */
function field_filter_xss($string) {
313
  return Html::normalize(Xss::filter($string, _field_filter_xss_allowed_tags()));
314 315 316
}

/**
317
 * Returns a list of tags allowed by field_filter_xss().
318 319 320 321 322 323
 */
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');
}

/**
324
 * Returns a human-readable list of allowed tags for display in help texts.
325 326 327 328 329 330
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

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

353
  if ($entity->hasField($field_name)) {
354 355 356 357 358
    // Clone the entity since we are going to modify field values.
    $clone = clone $entity;

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

360 361
    // 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.
362
    $clone->{$field_name}->setValue(array($item));
363
    $elements = field_view_field($clone, $field_name, $display, $langcode);
364

365 366 367 368
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
369 370
    }
  }
371 372

  return $output;
373 374 375
}

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

428
  // Return nothing if the field doesn't exist.
429
  if (!$entity->hasField($field_name)) {
430 431 432
    return $output;
  }

433
  // Get the display object.
434 435
  if (is_string($display_options)) {
    $view_mode = $display_options;
436 437 438 439 440 441
    $display = EntityViewDisplay::collectRenderDisplay($entity, $view_mode);
    foreach ($entity as $name => $items) {
      if ($name != $field_name) {
        $display->removeComponent($name);
      }
    }
442 443 444
  }
  else {
    $view_mode = '_custom';
445 446 447 448 449
    $display = entity_create('entity_view_display', array(
      'targetEntityType' => $entity->getEntityTypeId(),
      'bundle' => $entity->bundle(),
      'mode' => $view_mode,
      'status' => TRUE,
450
    ));
451
    $display->setComponent($field_name, $display_options);
452 453
  }

454 455 456
  $build = $display->build($entity);
  if (isset($build[$field_name])) {
    $output = $build[$field_name];
457
  }
458

459 460 461
  return $output;
}

462 463 464 465 466
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
467
  $page['#attached']['css'][$path . '/css/field.module.css'] = array('every_page' => TRUE);
468 469
}

470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
/**
 * 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;
}

486
/**
487
 * Prepares variables for field templates.
488
 *
489 490 491 492 493 494 495 496 497
 * 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.
498
 */
499
function template_preprocess_field(&$variables, $hook) {
500 501
  $element = $variables['element'];

502 503 504 505 506 507 508
  // 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');
509
  $variables['label'] = check_plain($element['#title']);
510 511 512

  // We want other preprocess functions and the theme implementation to have
  // fast access to the field item render arrays. The item render array keys
513 514 515 516
  // (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.
517
  $variables['items'] = array();
518 519 520 521
  $delta = 0;
  while (!empty($element[$delta])) {
    $variables['items'][$delta] = $element[$delta];
    $delta++;
522 523 524 525 526
  }

  // 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().
527
  $variables['entity_type_css'] = strtr($element['#entity_type'], '_', '-');
528 529
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
530
  $variables['attributes']['class'] = array(
531
    'field',
532
    'field-' . $variables['entity_type_css'] . '--' . $variables['field_name_css'],
533 534 535
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
536
  );
537
  // Add a "clearfix" class to the wrapper since we float the label and the
538
  // field items in field.module.css if the label is inline.
539
  if ($element['#label_display'] == 'inline') {
540
    $variables['attributes']['class'][] = 'clearfix';
541
  }
542

543 544
  static $default_attributes;
  if (!isset($default_attributes)) {
545
    $default_attributes = new Attribute;
546
  }
547 548 549 550 551 552 553
  // 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.
554 555 556
  $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);
557 558 559 560 561 562 563 564

  // 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().
565
  foreach ($variables['items'] as $delta => $item) {
566
    $variables['item_attributes'][$delta] = !empty($element['#items'][$delta]->_attributes) ? new Attribute($element['#items'][$delta]->_attributes) : clone($default_attributes);
567 568
  }
}
569

570
/**
571
 * @} End of "defgroup field".
572
 */
573 574

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

  // Render the label, if it's not hidden.
  if (!$variables['label_hidden']) {
639
    $output .= '<div class="field-label"' . $variables['title_attributes'] . '>' . $variables['label'] . '</div>';
640 641 642 643 644
  }

  // Render the items.
  $output .= '<div class="field-items"' . $variables['content_attributes'] . '>';
  foreach ($variables['items'] as $delta => $item) {
645
    $output .= '<div class="field-item"' . $variables['item_attributes'][$delta] . '>' . drupal_render($item, TRUE) . '</div>';
646 647 648 649
  }
  $output .= '</div>';

  // Render the top-level DIV.
650
  $output = '<div' . $variables['attributes'] . '>' . $output . '</div>';
651 652 653

  return $output;
}
654 655 656 657

/**
 * Assembles a partial entity structure with initial IDs.
 *
658
 * @param object $ids
659 660 661
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
662
 * @return \Drupal\Core\Entity\EntityInterface
663 664 665 666
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
667 668
  $entity_type = \Drupal::entityManager()->getDefinition($ids->entity_type);
  if ($id_key = $entity_type->getKey('id')) {
669
    $id_properties[$id_key] = $ids->entity_id;
670
  }
671
  if (isset($ids->revision_id) && $revision_key = $entity_type->getKey('revision')) {
672
    $id_properties[$revision_key] = $ids->revision_id;
673
  }
674
  if (isset($ids->bundle) && $bundle_key = $entity_type->getKey('bundle')) {
675
    $id_properties[$bundle_key] = $ids->bundle;
676 677
  }
  return entity_create($ids->entity_type, $id_properties);
678 679
}

680 681 682 683 684 685 686 687 688 689 690 691 692
/**
 * 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;
}