field.module 32.4 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\Template\Attribute;
9
use Drupal\field\FieldInterface;
10
use Drupal\field\FieldInstanceInterface;
11

12
/*
13 14 15
 * 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.
16
 */
17 18 19 20
require_once __DIR__ . '/field.info.inc';
require_once __DIR__ . '/field.multilingual.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
 * Value for field API indicating a field accepts an unlimited number of values.
80
 */
81
const FIELD_CARDINALITY_UNLIMITED = -1;
82 83

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

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

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

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

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

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

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

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

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

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

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

  return $property_info;
}

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

  return $definition;
}

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

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

280 281 282 283 284 285 286 287 288 289 290 291
/**
 * 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();
292 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

  // 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) {
  // 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();
320 321
}

322 323 324 325
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
326
  // Refresh the 'active' status of fields.
327 328 329
  field_sync_field_status();
}

330
/**
331
 * Implements hook_modules_installed().
332
 */
333
function field_modules_installed($modules) {
334 335 336 337 338
  // Refresh the 'active' status of fields.
  field_sync_field_status();
}

/**
339
 * Implements hook_modules_uninstalled().
340
 */
341
function field_modules_uninstalled($modules) {
342 343 344 345
  // Refresh the 'active' status of fields.
  field_sync_field_status();
}

346
/**
347
 * Refreshes the 'active' and 'storage[active]' values for fields.
348 349
 */
function field_sync_field_status() {
350 351
  $module_handler = \Drupal::moduleHandler();
  $state = \Drupal::state();
352 353 354

  // Get both deleted and non-deleted field definitions.
  $fields = array();
355
  foreach (config_get_storage_names_with_prefix('field.field.') as $name) {
356
    $field = \Drupal::config($name)->get();
357
    $fields[$field['uuid']] = $field;
358
  }
359 360
  $deleted_fields = $state->get('field.field.deleted') ?: array();
  $fields += $deleted_fields;
361

362 363
  if (empty($fields)) {
    return;
364
  }
365 366 367 368 369

  // Set the 'module' and 'active' values for the current set of enabled
  // modules.
  $changed = array();
  $modules = $module_handler->getModuleList();
370
  $field_types = \Drupal::service('plugin.manager.entity.field.field_type')->getDefinitions();
371
  // Set fields with missing field type modules to inactive.
372
  foreach ($fields as $uuid => &$field) {
373
    // Associate field types.
374 375
    if (isset($field_types[$field['type']]) && ($field['module'] != $field_types[$field['type']]['provider'] || !$field['active'])) {
      $field['module'] = $field_types[$field['type']]['provider'];
376 377 378
      $field['active'] = TRUE;
      $changed[$uuid] = $field;
    }
379 380 381 382 383 384 385 386 387 388 389 390
    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 {
391
      \Drupal::config('field.field.' . $field['id'])
392 393 394 395 396 397 398 399
        ->set('module', $field['module'])
        ->set('active', $field['active'])
        ->save();
    }
  }
  $state->set('field.field.deleted', $deleted_fields);

  field_cache_clear();
400 401 402
}

/**
403
 * Clears the field info and field data caches.
404
 */
405
function field_cache_clear() {
406
  cache('field')->deleteAll();
407
  field_info_cache_clear();
408 409 410
}

/**
411 412
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
413 414
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
415 416 417 418 419 420 421 422 423 424
 * 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.
425 426
 */
function field_filter_xss($string) {
427
  return _filter_htmlcorrector(filter_xss($string, _field_filter_xss_allowed_tags()));
428 429 430
}

/**
431
 * Returns a list of tags allowed by field_filter_xss().
432 433 434 435 436 437
 */
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');
}

/**
438
 * Returns a human-readable list of allowed tags for display in help texts.
439 440 441 442 443 444
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
445
 * Returns a renderable array for a single field value.
446
 *
447
 * @param \Drupal\Core\Entity\EntityInterface $entity
448
 *   The entity containing the field to display. Must at least contain the ID
449 450 451
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
452
 * @param $item
453
 *   The field item value to display.
454
 * @param $display
455 456
 *   Can be either the name of a view mode, or an array of display settings. See
 *   field_view_field() for more information.
457
 * @param $langcode
458 459 460
 *   (Optional) The language of the value in $item. If not provided, the current
 *   language will be assumed.
 *
461
 * @return
462
 *   A renderable array for the field value.
463
 */
464
function field_view_value(EntityInterface $entity, $field_name, $item, $display = array(), $langcode = NULL) {
465
  $output = array();
466

467
  if ($field = field_info_field($entity->entityType(), $field_name)) {
468
    // Determine the langcode that will be used by language fallback.
469
    $langcode = field_language($entity, $field_name, $langcode);
470

471 472 473
    // 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;
474
    $clone->getTranslation($langcode)->{$field_name}->setValue(array($item));
475
    $elements = field_view_field($clone, $field_name, $display, $langcode);
476

477 478 479 480
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
481 482
    }
  }
483 484

  return $output;
485 486 487
}

/**
488
 * Returns a renderable array for the value of a single field in an entity.
489
 *
490
 * The resulting output is a fully themed field with label and multiple values.
491
 *
492 493
 * This function can be used by third-party modules that need to output an
 * isolated field.
494
 * - Do not use inside node (or any other entity) templates; use
495
 *   render($content[FIELD_NAME]) instead.
496
 * - Do not use to display all fields in an entity; use
497
 *   field_attach_prepare_view() and field_attach_view() instead.
498 499
 * - The field_view_value() function can be used to output a single formatted
 *   field value, without label or wrapping field markup.
500
 *
501 502 503
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
504 505
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity containing the field to display.
506 507
 * @param $field_name
 *   The name of the field to display.
508
 * @param $display_options
509
 *   Can be either:
510 511
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
512 513 514
 *     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.
515
 *   - An array of display options. The following key/value pairs are allowed:
516 517 518 519
 *     - 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
520 521
 *       'default_formatter' for the field type. The default formatter will also
 *       be used if the requested formatter is not available.
522
 *     - settings: (array) Settings specific to the formatter. Defaults to the
523
 *       formatter's default settings.
524 525 526
 *     - weight: (float) The weight to assign to the renderable element.
 *       Defaults to 0.
 * @param $langcode
527 528
 *   (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
529
 *   available for the given language code. If no language code is provided the
530
 *   current language will be used.
531
 *
532
 * @return
533
 *   A renderable array for the field value.
534 535
 *
 * @see field_view_value()
536
 */
537
function field_view_field(EntityInterface $entity, $field_name, $display_options = array(), $langcode = NULL) {
538
  $output = array();
539
  $bundle = $entity->bundle();
540
  $entity_type = $entity->entityType();
541

542
  // Return nothing if the field doesn't exist.
543
  $instance = field_info_instance($entity_type, $field_name, $bundle);
544 545 546 547 548 549 550
  if (!$instance) {
    return $output;
  }

  // Get the formatter object.
  if (is_string($display_options)) {
    $view_mode = $display_options;
551
    $formatter = entity_get_render_display($entity, $view_mode)->getRenderer($field_name);
552 553 554 555 556
  }
  else {
    $view_mode = '_custom';
    // hook_field_attach_display_alter() needs to receive the 'prepared'
    // $display_options, so we cannot let preparation happen internally.
557
    $field = field_info_field($entity_type, $field_name);
558 559 560
    $formatter_manager = drupal_container()->get('plugin.manager.field.formatter');
    $display_options = $formatter_manager->prepareConfiguration($field['type'], $display_options);
    $formatter = $formatter_manager->getInstance(array(
561
      'field_definition' => $instance,
562 563 564 565 566 567 568
      'view_mode' => $view_mode,
      'prepare' => FALSE,
      'configuration' => $display_options,
    ));
  }

  if ($formatter) {
569
    $display_langcode = field_language($entity, $field_name, $langcode);
570

571
    // Invoke the formatter's prepareView() and view() methods.
572
    $items = $entity->getTranslation($display_langcode)->get($field_name);
573 574
    $formatter->prepareView(array($entity->id() => $items));
    $result = $formatter->view($items);
575

576 577 578 579 580 581
    // 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,
582
      'langcode' => $display_langcode,
583 584
    );
    drupal_alter('field_attach_view', $result, $context);
585

586 587
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
588
    }
589
  }
590

591 592 593
  return $output;
}

594
/**
595
 * Extracts the bundle name from a bundle object.
596
 *
597
 * @param $entity_type
598
 *   The type of $entity; e.g., 'node' or 'user'.
599
 * @param $bundle
600
 *   The bundle object (or string if bundles for this entity type do not exist
601
 *   as standalone objects).
602
 *
603 604 605
 * @return
 *   The bundle name.
 */
606
function field_extract_bundle($entity_type, $bundle) {
607 608 609 610
  if (is_string($bundle)) {
    return $bundle;
  }

611
  $info = entity_get_info($entity_type);
612 613
  if (is_object($bundle) && isset($info['bundle_keys']['bundle']) && isset($bundle->{$info['bundle_keys']['bundle']})) {
    return $bundle->{$info['bundle_keys']['bundle']};
614 615 616
  }
}

617 618 619 620 621
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
622
  $page['#attached']['css'][$path . '/css/field.module.css'] = array('every_page' => TRUE);
623 624
}

625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
/**
 * 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;
}

641
/**
642
 * Prepares variables for field templates.
643
 *
644 645 646 647 648 649 650 651 652
 * 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.
653
 */
654
function template_preprocess_field(&$variables, $hook) {
655 656
  $element = $variables['element'];

657 658 659 660 661 662 663 664 665 666 667
  // 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
668 669 670 671
  // (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.
672
  $variables['items'] = array();
673 674 675 676
  $delta = 0;
  while (!empty($element[$delta])) {
    $variables['items'][$delta] = $element[$delta];
    $delta++;
677 678 679 680 681
  }

  // 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().
682
  $variables['entity_type_css'] = strtr($element['#entity_type'], '_', '-');
683 684
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
685
  $variables['attributes']['class'] = array(
686
    'field',
687
    'field-' . $variables['entity_type_css'] . '--' . $variables['field_name_css'],
688 689 690
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
691
  );
692
  // Add a "clearfix" class to the wrapper since we float the label and the
693
  // field items in field.module.css if the label is inline.
694
  if ($element['#label_display'] == 'inline') {
695
    $variables['attributes']['class'][] = 'clearfix';
696
  }
697

698 699
  static $default_attributes;
  if (!isset($default_attributes)) {
700
    $default_attributes = new Attribute;
701
  }
702 703 704 705 706 707 708
  // 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.
709 710 711
  $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);
712 713 714 715 716 717 718 719

  // 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().
720
  foreach ($variables['items'] as $delta => $item) {
721
    $variables['item_attributes'][$delta] = !empty($element['#items'][$delta]['_attributes']) ? new Attribute($element['#items'][$delta]['_attributes']) : clone($default_attributes);
722 723
  }
}
724

725
/**
726
 * @} End of "defgroup field".
727
 */
728 729

/**
730
 * Returns HTML for a field.
731 732 733 734 735 736 737 738 739 740 741 742 743 744
 *
 * 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
745 746
 * 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
747
 * customize it, just like customizing other Drupal templates such as
748
 * page.html.twig or node.html.twig. However, it takes longer for the server to
749 750
 * 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.
751
 * For these websites, developers are discouraged from placing a field.html.twig
752 753 754 755
 * 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:
756 757 758 759
 * - field--body--article.html.twig
 * - field--article.html.twig
 * - field--body.html.twig
 * - field.html.twig
760
 * So, if the body field on the article content type needs customization, a
761
 * field--body--article.html.twig file can be added within the theme's folder.
762
 * Because it's a template, it will result in slightly more time needed to
763 764
 * 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
765 766 767 768 769 770
 * 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.
 *
771 772
 * @param $variables
 *   An associative array containing:
773 774
 *   - label_hidden: A boolean indicating whether to show or hide the field
 *     label.
775 776
 *   - title_attributes: A string containing the attributes for the title.
 *   - label: The label for the field.
777
 *   - content_attributes: A string containing the attributes for the content's
778 779 780 781 782 783
 *     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.
 *
784
 * @see template_preprocess_field()
785
 * @see field.html.twig
786 787 788 789 790 791 792 793
 *
 * @ingroup themeable
 */
function theme_field($variables) {
  $output = '';

  // Render the label, if it's not hidden.
  if (!$variables['label_hidden']) {
794
    $output .= '<div class="field-label"' . $variables['title_attributes'] . '>' . $variables['label'] . '</div>';
795 796 797 798 799 800 801 802 803 804 805
  }

  // 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.
806
  $output = '<div' . $variables['attributes'] . '>' . $output . '</div>';
807 808 809

  return $output;
}
810 811 812 813 814 815 816 817

/**
 * 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).
 *
818
 * @return \Drupal\Core\Entity\EntityInterface
819 820 821 822 823
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
  $info = entity_get_info($ids->entity_type);
824 825 826
  if (isset($info['entity_keys']['id'])) {
    $id_properties[$info['entity_keys']['id']] = $ids->entity_id;
  }
827 828
  if (!empty($info['entity_keys']['revision']) && isset($ids->revision_id)) {
    $id_properties[$info['entity_keys']['revision']] = $ids->revision_id;
829
  }
830 831
  if (!empty($info['entity_keys']['bundle']) && isset($ids->bundle)) {
    $id_properties[$info['entity_keys']['bundle']] = $ids->bundle;
832 833
  }
  return entity_create($ids->entity_type, $id_properties);
834 835
}

836 837 838 839 840 841 842 843 844 845 846 847 848
/**
 * 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;
}