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

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

13
/*
14 15 16
 * Load all public Field API functions. Drupal currently has no
 * mechanism for auto-loading core APIs, so we have to load them on
 * every page request.
17
 */
18 19 20 21
require_once __DIR__ . '/field.info.inc';
require_once __DIR__ . '/field.multilingual.inc';
require_once __DIR__ . '/field.attach.inc';
require_once __DIR__ . '/field.form.inc';
22 23
require_once __DIR__ . '/field.purge.inc';
require_once __DIR__ . '/field.deprecated.inc';
24

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

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

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

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

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

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

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

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

      // 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');
148
      $modules = array_merge(Drupal::moduleHandler()->getImplementations('field_info'), Drupal::moduleHandler()->getImplementations('field_widget_info'));
149 150 151 152
      $modules = array_unique($modules);
      sort($modules);
      foreach ($modules as $module) {
        $display = $info[$module]['name'];
153
        if (Drupal::moduleHandler()->implementsHook($module, 'help')) {
154 155 156 157 158 159
          $items['items'][] = l($display, 'admin/help/' . $module);
        }
        else {
          $items['items'][] = $display;
        }
      }
160 161 162 163 164
      $item_list = array(
        '#theme' => 'item_list',
        '#items' => $items['items'],
      );
      $output .= drupal_render($item_list) . '</dd>';
165
      $output .= '<dt>' . t('Managing field data storage') . '</dt>';
166
      $output .= '<dd>' . t('Developers of field modules can either use the default <a href="@sql-store">Field SQL Storage module</a> to store data for their fields, or a contributed or custom module developed using the <a href="@storage-api">field storage API</a>.', array('@storage-api' => 'http://api.drupal.org/api/group/field_storage/8', '@sql-store' => url('admin/help/field_sql_storage'))) . '</dd>';
167
      $output .= '</dl>';
168 169 170 171 172
      return $output;
  }
}

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

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

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

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

236 237 238 239 240 241 242 243 244 245
/**
 * 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) {
246
      $definition = _field_generate_entity_field_definition($instance->getField());
247

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

  return $property_info;
}

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
/**
 * 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(
    'label' => t('Field !name', array('!name' => $field->id())),
    'type' => 'field_item:' . $field->type,
    'list' => TRUE,
    'configurable' => TRUE,
    'translatable' => !empty($field->translatable),
  );
  if ($instance) {
    $definition['instance'] = $instance;
  }

  return $definition;
}

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

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

304 305 306 307 308 309 310 311 312 313 314 315
/**
 * 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();
316 317
    }
  }
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351

  // Clear the field cache.
  field_cache_clear();

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

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

  // Clear the cache.
  field_cache_clear();

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

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

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
/**
 * Implements hook_modules_enabled().
 */
function field_modules_enabled($modules) {
  // Refresh the 'active' status of fields.
  field_sync_field_status();
}

/**
 * Implements hook_modules_disabled().
 */
function field_modules_disabled($modules) {
  // Refresh the 'active' status of fields.
  field_sync_field_status();
}

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

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

394 395
  if (empty($fields)) {
    return;
396
  }
397 398 399 400 401 402

  // Set the 'module' and 'active' values for the current set of enabled
  // modules.
  $changed = array();
  $modules = $module_handler->getModuleList();
  foreach ($modules as $module => $module_info) {
403
    // Collect storage backends exposed by the module.
404 405
    $storage_types = (array) $module_handler->invoke($module, 'field_storage_info');

406
    if ($storage_types) {
407 408 409 410 411 412 413 414 415
      foreach ($fields as $uuid => &$field) {
        // Associate storage backends.
        if (isset($storage_types[$field['storage']['type']]) && ($field['storage']['module'] !== $module || !$field['storage']['active'])) {
          $field['storage']['module'] = $module;
          $field['storage']['active'] = TRUE;
          $changed[$uuid] = $field;
        }
      }
    }
416
  }
417

418
  $field_types = Drupal::service('plugin.manager.entity.field.field_type')->getDefinitions();
419 420
  // Set fields with missing field type or storage modules to inactive.
  foreach ($fields as $uuid => &$field) {
421
    // Associate field types.
422 423
    if (isset($field_types[$field['type']]) && ($field['module'] != $field_types[$field['type']]['provider'] || !$field['active'])) {
      $field['module'] = $field_types[$field['type']]['provider'];
424 425 426
      $field['active'] = TRUE;
      $changed[$uuid] = $field;
    }
427 428 429 430
    if (!isset($modules[$field['module']]) && $field['active']) {
      $field['active'] = FALSE;
      $changed[$uuid] = $field;
    }
431
    // Disassociate storage backends.
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
    if (!isset($modules[$field['storage']['module']]) && $field['storage']['active']) {
      $field['storage']['active'] = FALSE;
      $changed[$uuid] = $field;
    }
  }

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

  field_cache_clear();
455 456
}

457
/**
458 459
 * Gets or sets administratively defined bundle settings.
 *
460
 * @param string $entity_type
461
 *   The type of $entity; e.g., 'node' or 'user'.
462
 * @param string $bundle
463
 *   The bundle name.
464 465 466 467 468
 * @param array|null $settings
 *   (optional) The settings to store, an associative array with the following
 *   elements:
 *   - view_modes: An associative array keyed by view mode, with the following
 *     key/value pairs:
469 470 471
 *     - status: Boolean specifying whether the view mode uses a dedicated set
 *       of display options (TRUE), or the 'default' options (FALSE). Defaults
 *       to FALSE.
472 473 474 475 476 477 478 479 480 481 482 483 484
 *   - extra_fields: An associative array containing the form and display
 *     settings for extra fields (also known as pseudo-fields):
 *     - form: An associative array whose keys are the names of extra fields,
 *       and whose values are associative arrays with the following elements:
 *       - weight: The weight of the extra field, determining its position on an
 *         entity form.
 *     - display: An associative array whose keys are the names of extra fields,
 *       and whose values are associative arrays keyed by the name of view
 *       modes. This array must include an item for the 'default' view mode.
 *       Each view mode sub-array contains the following elements:
 *       - weight: The weight of the extra field, determining its position when
 *         an entity is viewed.
 *       - visible: TRUE if the extra field is visible, FALSE otherwise.
485
 *
486
 * @return array|null
487 488 489 490
 *   If no $settings are passed, the current settings are returned.
 */
function field_bundle_settings($entity_type, $bundle, $settings = NULL) {
  if (isset($settings)) {
491
    variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle, $settings);
492
    field_info_cache_clear();
493 494
  }
  else {
495
    $settings = variable_get('field_bundle_settings_' . $entity_type . '__' . $bundle, array());
496 497
    $settings += array(
      'view_modes' => array(),
498
      'form_modes' => array(),
499
    );
500 501 502 503 504

    return $settings;
  }
}

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
/**
 * Returns form mode settings in a given bundle.
 *
 * @param string $entity_type
 *   The type of entity; e.g. 'node' or 'user'.
 * @param string $bundle
 *   The bundle name to return form mode settings for.
 *
 * @return
 *   An array keyed by form mode, with the following key/value pairs:
 *   - status: Boolean specifying whether the form mode uses a dedicated set of
 *     display options (TRUE), or the 'default' options (FALSE). Defaults to
 *     FALSE.
 */
function field_form_mode_settings($entity_type, $bundle) {
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$entity_type][$bundle])) {
    $bundle_settings = field_bundle_settings($entity_type, $bundle);
    $settings = $bundle_settings['form_modes'];
    // Include form modes for which nothing has been stored yet, but whose
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
    $form_modes = entity_get_form_modes($entity_type);
    foreach ($form_modes as $form_mode => $form_mode_info) {
      if (!isset($settings[$form_mode]['status']) && $form_mode_info['status']) {
        $settings[$form_mode]['status'] = TRUE;
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

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

540 541 542 543 544 545 546 547 548 549
/**
 * Returns view mode settings in a given bundle.
 *
 * @param $entity_type
 *   The type of entity; e.g. 'node' or 'user'.
 * @param $bundle
 *   The bundle name to return view mode settings for.
 *
 * @return
 *   An array keyed by view mode, with the following key/value pairs:
550 551 552
 *   - status: Boolean specifying whether the view mode uses a dedicated set of
 *     display options (TRUE), or the 'default' options (FALSE). Defaults to
 *     FALSE.
553 554 555 556 557 558 559 560
 */
function field_view_mode_settings($entity_type, $bundle) {
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$entity_type][$bundle])) {
    $bundle_settings = field_bundle_settings($entity_type, $bundle);
    $settings = $bundle_settings['view_modes'];
    // Include view modes for which nothing has been stored yet, but whose
561 562
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
563 564
    $view_modes = entity_get_view_modes($entity_type);
    foreach ($view_modes as $view_mode => $view_mode_info) {
565 566
      if (!isset($settings[$view_mode]['status']) && $view_mode_info['status']) {
        $settings[$view_mode]['status'] = TRUE;
567 568 569 570 571 572 573 574
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

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

575
/**
576
 * Clears the field info and field data caches.
577
 */
578
function field_cache_clear() {
579
  cache('field')->deleteAll();
580
  field_info_cache_clear();
581 582 583
}

/**
584 585
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
586 587
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
588 589 590 591 592 593 594 595 596 597
 * 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.
598 599
 */
function field_filter_xss($string) {
600
  return _filter_htmlcorrector(filter_xss($string, _field_filter_xss_allowed_tags()));
601 602 603
}

/**
604
 * Returns a list of tags allowed by field_filter_xss().
605 606 607 608 609 610
 */
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');
}

/**
611
 * Returns a human-readable list of allowed tags for display in help texts.
612 613 614 615 616 617
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
618
 * Returns a renderable array for a single field value.
619
 *
620
 * @param \Drupal\Core\Entity\EntityInterface $entity
621
 *   The entity containing the field to display. Must at least contain the ID
622 623 624
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
625
 * @param $item
626 627 628
 *   The field value to display, as found in
 *   $entity->field_name[$langcode][$delta].
 * @param $display
629 630
 *   Can be either the name of a view mode, or an array of display settings. See
 *   field_view_field() for more information.
631
 * @param $langcode
632 633 634
 *   (Optional) The language of the value in $item. If not provided, the current
 *   language will be assumed.
 *
635
 * @return
636
 *   A renderable array for the field value.
637
 */
638
function field_view_value(EntityInterface $entity, $field_name, $item, $display = array(), $langcode = NULL) {
639
  $output = array();
640

641 642 643
  // Ensure we are working with a BC mode entity.
  $entity = $entity->getBCEntity();

644 645
  if ($field = field_info_field($field_name)) {
    // Determine the langcode that will be used by language fallback.
646
    $langcode = field_language($entity, $field_name, $langcode);
647

648 649 650 651
    // Push the item as the single value for the field, and defer to
    // field_view_field() to build the render array for the whole field.
    $clone = clone $entity;
    $clone->{$field_name}[$langcode] = array($item);
652
    $elements = field_view_field($clone, $field_name, $display, $langcode);
653

654 655 656 657
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
658 659
    }
  }
660 661

  return $output;
662 663 664
}

/**
665
 * Returns a renderable array for the value of a single field in an entity.
666
 *
667
 * The resulting output is a fully themed field with label and multiple values.
668
 *
669 670
 * This function can be used by third-party modules that need to output an
 * isolated field.
671
 * - Do not use inside node (or any other entity) templates; use
672
 *   render($content[FIELD_NAME]) instead.
673
 * - Do not use to display all fields in an entity; use
674
 *   field_attach_prepare_view() and field_attach_view() instead.
675 676
 * - The field_view_value() function can be used to output a single formatted
 *   field value, without label or wrapping field markup.
677
 *
678 679 680
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
681 682
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity containing the field to display.
683 684
 * @param $field_name
 *   The name of the field to display.
685
 * @param $display_options
686
 *   Can be either:
687 688
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
689 690 691
 *     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.
692
 *   - An array of display options. The following key/value pairs are allowed:
693 694 695 696
 *     - 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
697 698
 *       'default_formatter' for the field type. The default formatter will also
 *       be used if the requested formatter is not available.
699
 *     - settings: (array) Settings specific to the formatter. Defaults to the
700
 *       formatter's default settings.
701 702 703
 *     - weight: (float) The weight to assign to the renderable element.
 *       Defaults to 0.
 * @param $langcode
704 705
 *   (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
706
 *   available for the given language code. If no language code is provided the
707
 *   current language will be used.
708
 *
709
 * @return
710
 *   A renderable array for the field value.
711 712
 *
 * @see field_view_value()
713
 */
714
function field_view_field(EntityInterface $entity, $field_name, $display_options = array(), $langcode = NULL) {
715
  $output = array();
716
  $bundle = $entity->bundle();
717
  $entity_type = $entity->entityType();
718

719
  // Return nothing if the field doesn't exist.
720
  $instance = field_info_instance($entity_type, $field_name, $bundle);
721 722 723 724 725 726 727
  if (!$instance) {
    return $output;
  }

  // Get the formatter object.
  if (is_string($display_options)) {
    $view_mode = $display_options;
728
    $formatter = entity_get_render_display($entity, $view_mode)->getRenderer($field_name);
729 730 731 732 733 734 735 736 737
  }
  else {
    $view_mode = '_custom';
    // hook_field_attach_display_alter() needs to receive the 'prepared'
    // $display_options, so we cannot let preparation happen internally.
    $field = field_info_field($field_name);
    $formatter_manager = drupal_container()->get('plugin.manager.field.formatter');
    $display_options = $formatter_manager->prepareConfiguration($field['type'], $display_options);
    $formatter = $formatter_manager->getInstance(array(
738
      'field_definition' => $instance,
739 740 741 742 743 744 745
      'view_mode' => $view_mode,
      'prepare' => FALSE,
      'configuration' => $display_options,
    ));
  }

  if ($formatter) {
746
    $display_langcode = field_language($entity, $field_name, $langcode);
747

748
    // Invoke the formatter's prepareView() and view() methods.
749
    $items = $entity->getNGEntity()->getTranslation($display_langcode)->get($field_name);
750
    $id = $entity->id();
751 752
    $formatter->prepareView(array($id => $entity), $display_langcode, array($id => $items));
    $result = $formatter->view($entity, $display_langcode, $items);
753

754 755 756 757 758 759
    // 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,
760
      'langcode' => $display_langcode,
761 762
    );
    drupal_alter('field_attach_view', $result, $context);
763

764 765
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
766
    }
767
  }
768

769 770 771 772
  return $output;
}

/**
773
 * Determines whether the user has access to a given field.
774
 *
775
 * @param string $op
776
 *   The operation to be performed. Possible values:
777 778
 *   - edit
 *   - view
779 780
 * @param \Drupal\field\FieldInterface $field
 *   The field on which the operation is to be performed.
781 782
 * @param $entity_type
 *   The type of $entity; for example, 'node' or 'user'.
783
 * @param $entity
784
 *   (optional) The entity for the operation.
785 786
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
787
 *
788
 * @return
789
 *   TRUE if the operation is allowed; FALSE if the operation is denied.
790
 */
791
function field_access($op, FieldInterface $field, $entity_type, $entity = NULL, $account = NULL) {
792 793
  global $user;

794
  if (!isset($account)) {
795 796 797
    $account = $user;
  }

798
  foreach (Drupal::moduleHandler()->getImplementations('field_access') as $module) {
799
    $function = $module . '_field_access';
800
    $access = $function($op, $field, $entity_type, $entity, $account);
801
    if ($access === FALSE) {
802 803 804 805 806 807
      return FALSE;
    }
  }
  return TRUE;
}

808
/**
809
 * Extracts the bundle name from a bundle object.
810
 *
811
 * @param $entity_type
812
 *   The type of $entity; e.g., 'node' or 'user'.
813
 * @param $bundle
814
 *   The bundle object (or string if bundles for this entity type do not exist
815
 *   as standalone objects).
816
 *
817 818 819
 * @return
 *   The bundle name.
 */
820
function field_extract_bundle($entity_type, $bundle) {
821 822 823 824
  if (is_string($bundle)) {
    return $bundle;
  }

825
  $info = entity_get_info($entity_type);
826 827
  if (is_object($bundle) && isset($info['bundle_keys']['bundle']) && isset($bundle->{$info['bundle_keys']['bundle']})) {
    return $bundle->{$info['bundle_keys']['bundle']};
828 829 830
  }
}

831 832 833 834 835
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
836
  $page['#attached']['css'][$path . '/css/field.module.css'] = array('every_page' => TRUE);
837 838
}

839
/**
840
 * Prepares variables for field templates.
841
 *
842 843 844 845 846 847 848 849 850
 * 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.
851
 */
852
function template_preprocess_field(&$variables, $hook) {
853 854
  $element = $variables['element'];

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
  // There's some overhead in calling check_plain() so only call it if the label
  // variable is being displayed. Otherwise, set it to NULL to avoid PHP
  // warnings if a theme implementation accesses the variable even when it's
  // supposed to be hidden. If a theme implementation needs to print a hidden
  // label, it needs to supply a preprocess function that sets it to the
  // sanitized element title or whatever else is wanted in its place.
  $variables['label_hidden'] = ($element['#label_display'] == 'hidden');
  $variables['label'] = $variables['label_hidden'] ? NULL : check_plain($element['#title']);

  // We want other preprocess functions and the theme implementation to have
  // fast access to the field item render arrays. The item render array keys
  // (deltas) should always be a subset of the keys in #items, and looping on
  // those keys is faster than calling element_children() or looping on all keys
  // within $element, since that requires traversal of all element properties.
  $variables['items'] = array();
  foreach ($element['#items'] as $delta => $item) {
    if (!empty($element[$delta])) {
      $variables['items'][$delta] = $element[$delta];
    }
  }

  // Add default CSS classes. Since there can be many fields rendered on a page,
  // save some overhead by calling strtr() directly instead of
  // drupal_html_class().
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
881
  $variables['attributes']['class'] = array(
882 883 884 885
    'field',
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
886
  );
887
  // Add a "clearfix" class to the wrapper since we float the label and the
888
  // field items in field.module.css if the label is inline.
889
  if ($element['#label_display'] == 'inline') {
890
    $variables['attributes']['class'][] = 'clearfix';
891
  }
892

893 894
  // Add specific suggestions that can override the default implementation.
  $variables['theme_hook_suggestions'] = array(
895
    'field__' . $element['#field_type'],
896 897 898 899
    'field__' . $element['#field_name'],
    'field__' . $element['#bundle'],
    'field__' . $element['#field_name'] . '__' . $element['#bundle'],
  );
900

901 902
  static $default_attributes;
  if (!isset($default_attributes)) {
903
    $default_attributes = new Attribute;
904
  }
905 906 907 908 909 910 911
  // 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.
912 913 914
  $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);
915
  foreach ($variables['items'] as $delta => $item) {
916
    $variables['item_attributes'][$delta] = isset($variables['item_attributes'][$delta]) ? new Attribute($variables['item_attributes'][$delta]) : clone($default_attributes);
917 918
  }
}
919

920
/**
921
 * @} End of "defgroup field".
922
 */
923 924

/**
925
 * Returns HTML for a field.
926 927 928 929 930 931 932 933 934 935 936 937 938 939
 *
 * 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
940 941
 * 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
942
 * customize it, just like customizing other Drupal templates such as
943
 * page.html.twig or node.html.twig. However, it takes longer for the server to
944 945
 * 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.
946
 * For these websites, developers are discouraged from placing a field.html.twig
947 948 949 950
 * 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: