field.module 22.3 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\Entity\EntityTypeInterface;
11
use Drupal\Core\Extension\Extension;
12
use Drupal\Core\Template\Attribute;
13
use Drupal\entity\Entity\EntityViewDisplay;
14
use Drupal\field\Field;
15

16
/*
17 18 19
 * 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.
20
 */
21 22 23
require_once __DIR__ . '/field.info.inc';
require_once __DIR__ . '/field.attach.inc';
require_once __DIR__ . '/field.form.inc';
24 25
require_once __DIR__ . '/field.purge.inc';
require_once __DIR__ . '/field.deprecated.inc';
26

27 28 29
/**
 * @defgroup field Field API
 * @{
30 31 32 33 34 35 36 37
 * 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.
38
 *
39 40 41 42 43 44 45 46 47 48 49 50
 * 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
51
 * node storage controller loads an Article node, it loads the values of the
52 53
 * '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
 * - @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
75
 *   bulk deletion operations such as deletion of field or field_instance.
76 77
 *
 * - @link field_language Field language API @endlink: Provides native
78
 *   multilingual support for the Field API.
79 80 81
 */

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

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

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

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

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

194
/**
195
 * Implements hook_entity_bundle_field_info().
196
 */
197 198 199 200 201
function field_entity_bundle_field_info(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
  if ($entity_type->isFieldable()) {
    // Configurable fields, which are always attached to a specific bundle, are
    // added 'by bundle'.
    return Field::fieldInfo()->getBundleInstances($entity_type->id(), $bundle);
202 203 204
  }
}

205
/**
206
 * Implements hook_entity_bundle_create().
207
 */
208 209 210 211
function field_entity_bundle_create($entity_type, $bundle) {
  // Clear the cache.
  field_cache_clear();
}
212

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

  // 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) {
243 244 245
  // 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.
246
  $instances = entity_load_multiple_by_properties('field_instance_config', array('entity_type' => $entity_type, 'bundle' => $bundle));
247 248 249 250 251 252
  foreach ($instances as $instance) {
    $instance->delete();
  }

  // Clear the cache.
  field_cache_clear();
253 254
}

255 256 257 258
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
259
  field_cache_clear();
260 261
}

262
/**
263
 * Implements hook_modules_installed().
264
 */
265
function field_modules_installed($modules) {
266
  field_cache_clear();
267 268 269
}

/**
270
 * Implements hook_modules_uninstalled().
271
 */
272
function field_modules_uninstalled($modules) {
273
  field_cache_clear();
274 275 276
}

/**
277
 * Clears the field info and field data caches.
278
 */
279
function field_cache_clear() {
280
  \Drupal::cache('field')->deleteAll();
281
  field_info_cache_clear();
282 283 284
}

/**
285 286
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
287 288
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
289 290 291 292 293 294 295 296 297 298
 * 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.
299 300
 */
function field_filter_xss($string) {
301
  return Html::normalize(Xss::filter($string, _field_filter_xss_allowed_tags()));
302 303 304
}

/**
305
 * Returns a list of tags allowed by field_filter_xss().
306 307 308 309 310 311
 */
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');
}

/**
312
 * Returns a human-readable list of allowed tags for display in help texts.
313 314 315 316 317
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

318 319 320 321 322
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
323
  $page['#attached']['css'][$path . '/css/field.module.css'] = array('every_page' => TRUE);
324 325
}

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
/**
 * 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;
}

342
/**
343
 * Prepares variables for field templates.
344
 *
345 346 347 348 349 350 351 352 353
 * 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.
354
 */
355
function template_preprocess_field(&$variables, $hook) {
356 357
  $element = $variables['element'];

358 359 360 361 362 363 364
  // 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');
365
  $variables['label'] = check_plain($element['#title']);
366 367 368

  // We want other preprocess functions and the theme implementation to have
  // fast access to the field item render arrays. The item render array keys
369 370 371 372
  // (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.
373
  $variables['items'] = array();
374 375 376 377
  $delta = 0;
  while (!empty($element[$delta])) {
    $variables['items'][$delta] = $element[$delta];
    $delta++;
378 379 380 381 382
  }

  // 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().
383
  $variables['entity_type_css'] = strtr($element['#entity_type'], '_', '-');
384 385
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
386
  $variables['attributes']['class'] = array(
387
    'field',
388
    'field-' . $variables['entity_type_css'] . '--' . $variables['field_name_css'],
389 390 391
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
392
  );
393
  // Add a "clearfix" class to the wrapper since we float the label and the
394
  // field items in field.module.css if the label is inline.
395
  if ($element['#label_display'] == 'inline') {
396
    $variables['attributes']['class'][] = 'clearfix';
397
  }
398

399 400
  static $default_attributes;
  if (!isset($default_attributes)) {
401
    $default_attributes = new Attribute;
402
  }
403 404 405 406 407 408 409
  // 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.
410 411 412
  $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);
413 414 415 416 417 418 419 420

  // 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().
421
  foreach ($variables['items'] as $delta => $item) {
422
    $variables['item_attributes'][$delta] = !empty($element['#items'][$delta]->_attributes) ? new Attribute($element['#items'][$delta]->_attributes) : clone($default_attributes);
423 424
  }
}
425

426
/**
427
 * @} End of "defgroup field".
428
 */
429 430

/**
431
 * Returns HTML for a field.
432 433 434 435 436 437 438 439 440 441 442 443 444 445
 *
 * 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
446 447
 * 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
448
 * customize it, just like customizing other Drupal templates such as
449
 * page.html.twig or node.html.twig. However, it takes longer for the server to
450 451
 * 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.
452
 * For these websites, developers are discouraged from placing a field.html.twig
453 454 455 456
 * 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:
457 458 459 460
 * - field--body--article.html.twig
 * - field--article.html.twig
 * - field--body.html.twig
 * - field.html.twig
461
 * So, if the body field on the article content type needs customization, a
462
 * field--body--article.html.twig file can be added within the theme's folder.
463
 * Because it's a template, it will result in slightly more time needed to
464 465
 * 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
466 467 468 469 470 471
 * 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.
 *
472
 * @param array $variables
473
 *   An associative array containing:
474 475
 *   - label_hidden: A boolean indicating whether to show or hide the field
 *     label.
476 477
 *   - title_attributes: A string containing the attributes for the title.
 *   - label: The label for the field.
478
 *   - content_attributes: A string containing the attributes for the content's
479 480 481 482 483 484
 *     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.
 *
485
 * @see template_preprocess_field()
486
 * @see field.html.twig
487 488 489 490 491 492 493 494
 *
 * @ingroup themeable
 */
function theme_field($variables) {
  $output = '';

  // Render the label, if it's not hidden.
  if (!$variables['label_hidden']) {
495
    $output .= '<div class="field-label"' . $variables['title_attributes'] . '>' . $variables['label'] . '</div>';
496 497 498 499 500
  }

  // Render the items.
  $output .= '<div class="field-items"' . $variables['content_attributes'] . '>';
  foreach ($variables['items'] as $delta => $item) {
501
    $output .= '<div class="field-item"' . $variables['item_attributes'][$delta] . '>' . drupal_render($item, TRUE) . '</div>';
502 503 504 505
  }
  $output .= '</div>';

  // Render the top-level DIV.
506
  $output = '<div' . $variables['attributes'] . '>' . $output . '</div>';
507 508 509

  return $output;
}
510 511 512 513

/**
 * Assembles a partial entity structure with initial IDs.
 *
514
 * @param object $ids
515 516 517
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
518
 * @return \Drupal\Core\Entity\EntityInterface
519 520 521 522
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
523 524
  $entity_type = \Drupal::entityManager()->getDefinition($ids->entity_type);
  if ($id_key = $entity_type->getKey('id')) {
525
    $id_properties[$id_key] = $ids->entity_id;
526
  }
527
  if (isset($ids->revision_id) && $revision_key = $entity_type->getKey('revision')) {
528
    $id_properties[$revision_key] = $ids->revision_id;
529
  }
530
  if (isset($ids->bundle) && $bundle_key = $entity_type->getKey('bundle')) {
531
    $id_properties[$bundle_key] = $ids->bundle;
532 533
  }
  return entity_create($ids->entity_type, $id_properties);
534 535
}

536 537 538 539 540 541 542 543 544 545 546 547 548
/**
 * 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;
}