field.api.php 54.1 KB
Newer Older
1 2 3 4 5 6 7 8
<?php
// $Id$

/**
 * @ingroup field_fieldable_type
 * @{
 */

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
/**
 * Expose "pseudo-field" components on fieldable objects.
 *
 * Field UI's 'Manage fields' page lets users re-order fields, but also
 * non-field components. For nodes, that would be title, menu settings, or
 * other elements exposed by contributed modules through hook_form() or
 * hook_form_alter().
 *
 * Fieldable entities or contributed modules that want to have their components
 * supported should expose them using this hook, and use
 * field_attach_extra_weight() to retrieve the user-defined weight when
 * inserting the component.
 *
 * @param $bundle
 *   The name of the bundle being considered.
 * @return
 *   An array of 'pseudo-field' components. The keys are the name of the element
 *   as it appears in the form structure. The values are arrays with the
 *   following key/value pairs:
 *   - label: The human readable name of the component.
 *   - description: A short description of the component contents.
 *   - weight: The default weight of the element.
 *   - view: (optional) The name of the element as it appears in the rendered
 *     structure, if different from the name in the form.
 */
function hook_field_extra_fields($bundle) {
  $extra = array();

  if ($type = node_type_get_type($bundle)) {
    if ($type->has_title) {
      $extra['title'] = array(
        'label' => $type->title_label,
        'description' => t('Node module element.'),
        'weight' => -5,
      );
    }
    if ($bundle == 'poll' && module_exists('poll')) {
      $extra['title'] = array(
        'label' => t('Poll title'),
        'description' => t('Poll module title.'),
        'weight' => -5,
      );
      $extra['choice_wrapper'] = array(
        'label' => t('Poll choices'),
        'description' => t('Poll module choices.'),
        'weight' => -4,
      );
      $extra['settings'] = array(
        'label' => t('Poll settings'),
        'description' => t('Poll module settings.'),
        'weight' => -3,
      );
    }
  }
  return $extra;
}

66 67 68 69 70 71 72
/**
 * @} End of "ingroup field_fieldable_type"
 */

/**
 * @defgroup field_types Field Types API
 * @{
73
 * Define field types, widget types, display formatter types, storage types.
74
 *
75
 * The bulk of the Field Types API are related to field types. A field type
76
 * represents a particular type of data (integer, string, date, etc.) that
77 78 79 80 81 82 83 84 85 86 87 88 89 90
 * can be attached to a fieldable object. hook_field_info() defines the basic
 * properties of a field type, and a variety of other field hooks are called by
 * the Field Attach API to perform field-type-specific actions.
 * @see hook_field_info().
 * @see hook_field_info_alter().
 * @see hook_field_schema().
 * @see hook_field_load().
 * @see hook_field_validate().
 * @see hook_field_presave().
 * @see hook_field_insert().
 * @see hook_field_update().
 * @see hook_field_delete().
 * @see hook_field_delete_revision().
 * @see hook_field_sanitize().
91
 * @see hook_field_is_empty().
92 93 94 95 96 97 98 99
 *
 * The Field Types API also defines two kinds of pluggable handlers: widgets
 * and formatters, which specify how the field appears in edit forms and in
 * displayed objects. Widgets and formatters can be implemented by a field-type
 * module for it's own field types, or by a third-party module to extend the
 * behavior of existing field types.
 * @see hook_field_widget_info().
 * @see hook_field_formatter_info().
100 101 102
 *
 * A third kind of pluggable handlers, storage backends, is defined by the
 * @link field_storage Field Storage API @endlink.
103 104 105 106 107 108
 */

/**
 * Define Field API field types.
 *
 * @return
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
 *   An array whose keys are field type names and whose values are arrays
 *   describing the field type, with the following key/value pairs:
 *   - label: The human-readable name of the field type.
 *   - description: A short description for the field type.
 *   - settings: An array whose keys are the names of the settings available
 *     for the field type, and whose values are the default values for those
 *     settings.
 *   - instance_settings: An array whose keys are the names of the settings
 *     available for instances of the field type, and whose values are the
 *     default values for those settings.
 *     Instance-level settings can have different values on each field
 *     instance, and thus allow greater flexibility than field-level settings.
 *     It is recommended to put settings at the instance level whenever
 *     possible. Notable exceptions: settings acting on the schema definition,
 *     or settings that Views needs to use across field instances (e.g. list of
 *     allowed values).
 *   - default_widget: The machine name of the default widget to be used by
 *     instances of this field type, when no widget is specified in the
 *     instance definition. This widget must be available whenever the field
 *     type is available (i.e. provided by the field type module, or by a module
 *     the field type module depends on).
 *   - default_formatter: The machine name of the default formatter to be used
 *     by instances of this field type, when no formatter is specified in the
 *     instance definition. This formatter must be available whenever the field
 *     type is available (i.e. provided by the field type module, or by a module
 *     the field type module depends on).
135 136 137 138 139 140 141 142 143 144 145
 */
function hook_field_info() {
  return array(
    'text' => array(
      'label' => t('Text'),
      'description' => t('This field stores varchar text in the database.'),
      'settings' => array('max_length' => 255),
      'instance_settings' => array('text_processing' => 0),
      'default_widget' => 'text_textfield',
      'default_formatter' => 'text_default',
    ),
146 147
    'text_long' => array(
      'label' => t('Long text'),
148
      'description' => t('This field stores long text in the database.'),
149
      'settings' => array('max_length' => ''),
150 151 152 153
      'instance_settings' => array('text_processing' => 0),
      'default_widget' => 'text_textarea',
      'default_formatter' => 'text_default',
    ),
154 155 156 157 158 159 160 161
    'text_with_summary' => array(
      'label' => t('Long text and summary'),
      'description' => t('This field stores long text in the database along with optional summary text.'),
      'settings' => array('max_length' => ''),
      'instance_settings' => array('text_processing' => 1, 'display_summary' => 0),
      'default_widget' => 'text_textarea_with_summary',
      'default_formatter' => 'text_summary_or_trimmed',
    ),
162 163 164
  );
}

165 166 167 168 169 170 171 172 173 174
/**
 * Perform alterations on Field API field types.
 *
 * @param $info
 *   Array of informations on widget types exposed by hook_field_info()
 *   implementations.
 */
function hook_field_info_alter(&$info) {
  // Add a setting to all field types.
  foreach ($info as $field_type => $field_type_info) {
175 176 177
    $info[$field_type]['settings'] += array(
      'mymodule_additional_setting' => 'default value',
    );
178 179 180 181 182 183 184 185
  }

  // Change the default widget for fields of type 'foo'.
  if (isset($info['foo'])) {
    $info['foo']['default widget'] = 'mymodule_widget';
  }
}

186 187 188 189 190 191
/**
 * Define the Field API schema for a field structure.
 *
 * @param $field
 *   A field structure.
 * @return
192
 *   An associative array with the following keys:
193 194
 *   - columns: An array of Schema API column specifications, keyed by column name.
 *     This specifies what comprises a value for a given field.
195 196 197 198 199 200 201
 *     For example, a value for a number field is simply 'value', while a
 *     value for a formatted text field is the combination of 'value' and
 *     'format'.
 *     It is recommended to avoid having the columns definitions depend on
 *     field settings when possible.
 *     No assumptions should be made on how storage engines internally use the
 *     original column name to structure their storage.
202
 *   - indexes: An array of Schema API indexes definitions. Only columns that
203 204 205 206 207
 *     appear in the 'columns' array are allowed.
 *     Those indexes will be used as default indexes. Callers of
 *     field_create_field() can specify additional indexes, or, at their own
 *     risk, modify the default indexes specified by the field-type module.
 *     Some storage engines might not support indexes.
208
 */
209 210
function hook_field_schema($field) {
  if ($field['type'] == 'text_long') {
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
    $columns = array(
      'value' => array(
        'type' => 'text',
        'size' => 'big',
        'not null' => FALSE,
      ),
    );
  }
  else {
    $columns = array(
      'value' => array(
        'type' => 'varchar',
        'length' => $field['settings']['max_length'],
        'not null' => FALSE,
      ),
    );
  }
  $columns += array(
    'format' => array(
      'type' => 'int',
      'unsigned' => TRUE,
      'not null' => FALSE,
    ),
  );
235 236 237 238 239 240
  return array(
    'columns' => $columns,
    'indexes' => array(
      'format' => array('format'),
    ),
  );
241 242 243 244 245
}

/**
 * Define custom load behavior for this module's field types.
 *
246 247 248 249 250
 * Unlike other field hooks, this hook operates on multiple objects. The
 * $objects, $instances and $items parameters are arrays keyed by object id.
 * For performance reasons, information for all available objects should be
 * loaded in a single query where possible.
 *
251 252 253 254 255
 * Note that the changes made to the field values get cached by the field cache
 * for subsequent loads. You should never use this hook to load fieldable
 * entities, since this is likely to cause infinite recursions when
 * hook_field_load() is run on those as well. Use
 * hook_field_formatter_prepare_view() instead.
256
 *
257 258
 * @param $obj_type
 *   The type of $object.
259 260
 * @param $objects
 *   Array of objects being loaded, keyed by object id.
261 262
 * @param $field
 *   The field structure for the operation.
263 264
 * @param $instances
 *   Array of instance structures for $field for each object, keyed by object id.
265 266
 * @param $langcode
 *   The language associated to $items.
267
 * @param $items
268 269 270 271 272 273 274
 *   Array of field values already loaded for the objects, keyed by object id.
 * @param $age
 *   FIELD_LOAD_CURRENT to load the most recent revision for all fields, or
 *   FIELD_LOAD_REVISION to load the version indicated by each object.
 * @return
 *   Changes or additions to field values are done by altering the $items
 *   parameter by reference.
275
 */
276
function hook_field_load($obj_type, $objects, $field, $instances, $langcode, &$items, $age) {
277 278 279 280 281 282 283
  foreach ($objects as $id => $object) {
    foreach ($items[$id] as $delta => $item) {
      if (!empty($instances[$id]['settings']['text_processing'])) {
        // Only process items with a cacheable format, the rest will be
        // handled by hook_field_sanitize().
        $format = $item['format'];
        if (filter_format_allowcache($format)) {
284
          $items[$id][$delta]['safe'] = isset($item['value']) ? check_markup($item['value'], $format, $langcode) : '';
285
          if ($field['type'] == 'text_with_summary') {
286
            $items[$id][$delta]['safe_summary'] = isset($item['summary']) ? check_markup($item['summary'], $format, $langcode) : '';
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
          }
        }
      }
      else {
        $items[$id][$delta]['safe'] = check_plain($item['value']);
        if ($field['type'] == 'text_with_summary') {
          $items[$id][$delta]['safe_summary'] = check_plain($item['summary']);
        }
      }
    }
  }
}

/**
 * Define custom sanitize behavior for this module's field types.
 *
 * This hook is invoked just before the field values are handed to formatters
 * for display. Formatters being essentially theme functions, it is important
 * that any data sanitization happens outside the theme layer.
 *
 * @param $obj_type
 *   The type of $object.
 * @param $object
 *   The object for the operation.
 * @param $field
 *   The field structure for the operation.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
315 316
 * @param $langcode
 *   The language associated to $items.
317 318 319
 * @param $items
 *   $object->{$field['field_name']}, or an empty array if unset.
 */
320
function hook_field_sanitize($obj_type, $object, $field, $instance, $langcode, &$items) {
321 322 323 324 325 326 327
  foreach ($items as $delta => $item) {
    // Only sanitize items which were not already processed inside
    // hook_field_load(), i.e. items with uncacheable text formats, or coming
    // from a form preview.
    if (!isset($items[$delta]['safe'])) {
      if (!empty($instance['settings']['text_processing'])) {
        $format = $item['format'];
328
        $items[$delta]['safe'] = isset($item['value']) ? check_markup($item['value'], $format, $langcode, TRUE) : '';
329
        if ($field['type'] == 'text_with_summary') {
330
          $items[$delta]['safe_summary'] = isset($item['summary']) ? check_markup($item['summary'], $format, $langcode, TRUE) : '';
331 332 333 334 335 336 337 338 339 340
        }
      }
      else {
        $items[$delta]['safe'] = check_plain($item['value']);
        if ($field['type'] == 'text_with_summary') {
          $items[$delta]['safe_summary'] = check_plain($item['summary']);
        }
      }
    }
  }
341 342 343 344 345 346 347 348 349
}

/**
 * Define custom validate behavior for this module's field types.
 *
 * @param $obj_type
 *   The type of $object.
 * @param $object
 *   The object for the operation.
350 351 352 353
 *   Note that this might not be a full-fledged 'object'. When invoked through
 *   field_attach_query(), the $object will only include properties that the
 *   Field API knows about: bundle, id, revision id, and field values (no node
 *   title, user name...).
354 355 356 357
 * @param $field
 *   The field structure for the operation.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
358 359
 * @param $langcode
 *   The language associated to $items.
360
 * @param $items
361
 *   $object->{$field['field_name']}[$langcode], or an empty array if unset.
362 363 364 365 366 367 368
 * @param $errors
 *   The array of errors, keyed by field name and by value delta, that have
 *   already been reported for the object. The function should add its errors
 *   to this array. Each error is an associative array, with the following
 *   keys and values:
 *   - 'error': an error code (should be a string, prefixed with the module name)
 *   - 'message': the human readable message to be displayed.
369
 */
370
function hook_field_validate($obj_type, $object, $field, $instance, $langcode, &$items, &$errors) {
371 372 373 374 375 376 377 378 379 380
  foreach ($items as $delta => $item) {
    if (!empty($item['value'])) {
      if (!empty($field['settings']['max_length']) && drupal_strlen($item['value']) > $field['settings']['max_length']) {
        $errors[$field['field_name']][$delta][] = array(
          'error' => 'text_max_length',
          'message' => t('%name: the value may not be longer than %max characters.', array('%name' => $instance['label'], '%max' => $field['settings']['max_length'])),
        );
      }
    }
  }
381 382 383 384
}

/**
 * Define custom presave behavior for this module's field types.
385
 *
386 387 388 389 390 391 392 393
 * @param $obj_type
 *   The type of $object.
 * @param $object
 *   The object for the operation.
 * @param $field
 *   The field structure for the operation.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
394 395
 * @param $langcode
 *   The language associated to $items.
396
 * @param $items
397
 *   $object->{$field['field_name']}[$langcode], or an empty array if unset.
398
 */
399
function hook_field_presave($obj_type, $object, $field, $instance, $langcode, &$items) {
400 401 402 403 404 405 406 407 408 409 410 411 412
}

/**
 * Define custom insert behavior for this module's field types.
 *
 * @param $obj_type
 *   The type of $object.
 * @param $object
 *   The object for the operation.
 * @param $field
 *   The field structure for the operation.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
413 414
 * @param $langcode
 *   The language associated to $items.
415
 * @param $items
416
 *   $object->{$field['field_name']}[$langcode], or an empty array if unset.
417
 */
418
function hook_field_insert($obj_type, $object, $field, $instance, $langcode, &$items) {
419 420 421 422 423 424 425 426 427 428 429 430 431
}

/**
 * Define custom update behavior for this module's field types.
 *
 * @param $obj_type
 *   The type of $object.
 * @param $object
 *   The object for the operation.
 * @param $field
 *   The field structure for the operation.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
432 433
 * @param $langcode
 *   The language associated to $items.
434
 * @param $items
435
 *   $object->{$field['field_name']}[$langcode], or an empty array if unset.
436
 */
437
function hook_field_update($obj_type, $object, $field, $instance, $langcode, &$items) {
438 439 440
}

/**
441
 * Define custom delete behavior for this module's field types.
442
 *
443
 * This hook is invoked just before the data is deleted from field storage.
444 445 446 447 448 449 450 451 452
 *
 * @param $obj_type
 *   The type of $object.
 * @param $object
 *   The object for the operation.
 * @param $field
 *   The field structure for the operation.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
453 454
 * @param $langcode
 *   The language associated to $items.
455
 * @param $items
456
 *   $object->{$field['field_name']}[$langcode], or an empty array if unset.
457
 */
458
function hook_field_delete($obj_type, $object, $field, $instance, $langcode, &$items) {
459 460 461
}

/**
462
 * Define custom delete_revision behavior for this module's field types.
463
 *
464 465
 * This hook is invoked just before the data is deleted from field storage,
 * and will only be called for fieldable types that are versioned.
466 467 468 469 470 471 472 473 474
 *
 * @param $obj_type
 *   The type of $object.
 * @param $object
 *   The object for the operation.
 * @param $field
 *   The field structure for the operation.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
475 476
 * @param $langcode
 *   The language associated to $items.
477
 * @param $items
478
 *   $object->{$field['field_name']}[$langcode], or an empty array if unset.
479
 */
480
function hook_field_delete_revision($obj_type, $object, $field, $instance, $langcode, &$items) {
481 482 483
}

/**
484 485 486
 * Define custom prepare_translation behavior for this module's field types.
 *
 * TODO: This hook may or may not survive in Field API.
487 488 489 490 491 492 493 494 495
 *
 * @param $obj_type
 *   The type of $object.
 * @param $object
 *   The object for the operation.
 * @param $field
 *   The field structure for the operation.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
496 497
 * @param $langcode
 *   The language associated to $items.
498
 * @param $items
499
 *   $object->{$field['field_name']}[$langcode], or an empty array if unset.
500
 */
501
function hook_field_prepare_translation($obj_type, $object, $field, $instance, $langcode, &$items) {
502 503
}

504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/**
 * Define what constitutes an empty item for a field type.
 *
 * @param $item
 *   An item that may or may not be empty.
 * @param $field
 *   The field to which $item belongs.
 * @return
 *   TRUE if $field's type considers $item not to contain any data;
 *   FALSE otherwise.
 */
function hook_field_is_empty($item, $field) {
  if (empty($item['value']) && (string)$item['value'] !== '0') {
    return TRUE;
  }
  return FALSE;
}

522
/**
523
 * Expose Field API widget types.
524
 *
525 526 527 528 529 530
 * Widgets are Form API elements with additional processing capabilities.
 * Widget hooks are typically called by the Field Attach API during the
 * creation of the field form structure with field_attach_form().
 * @see hook_field_widget_info_alter().
 * @see hook_field_widget().
 * @see hook_field_widget_error().
531
 *
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
 * @return
 *   An array describing the widget types implemented by the module.
 *
 *   The keys are widget type names. To avoid name clashes, widget type
 *   names should be prefixed with the name of the module that exposes them.
 *
 *   The values are arrays describing the widget type, with the following
 *   key/value pairs:
 *   - label: The human-readable name of the widget type.
 *   - description: A short description for the widget type.
 *   - field types: An array of field types the widget supports.
 *   - settings: An array whose keys are the names of the settings available
 *     for the widget type, and whose values are the default values for those
 *     settings.
 *   - behaviors: (optional) An array describing behaviors of the formatter.
 *     - multiple values:
 *       FIELD_BEHAVIOR_DEFAULT (default) if the widget allows the input of one
 *       single field value (most common case). The widget will be repeated for
 *       each value input.
 *       FIELD_BEHAVIOR_CUSTOM if one single copy of the widget can receive
 *       several field values. Examples: checkboxes, multiple select,
 *       comma-separated textfield...
 *     - default value:
 *       FIELD_BEHAVIOR_DEFAULT (default) if the widget accepts default values.
 *       FIELD_BEHAVIOR_NONE if the widget does not support default values.
557
 */
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
function hook_field_widget_info() {
    return array(
    'text_textfield' => array(
      'label' => t('Text field'),
      'field types' => array('text'),
      'settings' => array('size' => 60),
      'behaviors' => array(
        'multiple values' => FIELD_BEHAVIOR_DEFAULT,
        'default value' => FIELD_BEHAVIOR_DEFAULT,
      ),
    ),
    'text_textarea' => array(
      'label' => t('Text area (multiple rows)'),
      'field types' => array('text_long'),
      'settings' => array('rows' => 5),
      'behaviors' => array(
        'multiple values' => FIELD_BEHAVIOR_DEFAULT,
        'default value' => FIELD_BEHAVIOR_DEFAULT,
      ),
    ),
    'text_textarea_with_summary' => array(
      'label' => t('Text area with a summary'),
      'field types' => array('text_with_summary'),
      'settings' => array('rows' => 20, 'summary_rows' => 5),
      'behaviors' => array(
        'multiple values' => FIELD_BEHAVIOR_DEFAULT,
        'default value' => FIELD_BEHAVIOR_DEFAULT,
      ),
    ),
  );
}


/**
 * Perform alterations on Field API widget types.
 *
 * @param $info
 *   Array of informations on widget types exposed by hook_field_widget_info()
 *   implementations.
 */
function hook_field_widget_info_alter(&$info) {
  // Add a setting to a widget type.
  $info['text_textfield']['settings'] += array(
    'mymodule_additional_setting' => 'default value',
  );

  // Let a new field type re-use an existing widget.
  $info['options_select']['field types'][] = 'my_field_type';
606 607 608
}

/**
609
 * Return a single form element for a field widget.
610
 *
611 612 613
 * Field widget form elements should be based on the passed in $element, which
 * contains the base form element properties derived from the field
 * configuration.
614 615
 *
 * Field API will set the weight, field name and delta values for each
616
 * form element. If there are multiple values for this field, the
617 618 619
 * Field API will call this function as many times as needed.
 *
 * @param $form
620
 *   The entire form array.
621 622 623 624 625 626 627
 * @param $form_state
 *   The form_state, $form_state['values'][$field['field_name']]
 *   holds the field's form values.
 * @param $field
 *   The field structure.
 * @param $instance
 *   The field instance.
628 629
 * @param $langcode
 *   The language associated to $items.
630 631 632 633
 * @param $items
 *   Array of default values for this field.
 * @param $delta
 *   The order of this item in the array of subelements (0, 1, 2, etc).
634
 * @param $element
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
 *   A form element array containing basic properties for the widget:
 *   - #object_type: The name of the object the field is attached to.
 *   - #bundle: The name of the field bundle the field is contained in.
 *   - #field_name: The name of the field.
 *   - #columns: A list of field storage columns of the field.
 *   - #title: The sanitized element label for the field instance, ready for
 *     output.
 *   - #description: The sanitized element description for the field instance,
 *     ready for output.
 *   - #required: A Boolean indicating whether the element value is required;
 *     for required multiple value fields, only the first widget's values are
 *     required.
 *   - #delta: The order of this item in the array of subelements; see $delta
 *     above.
 *
650
 * @return
651
 *   The form elements for a single widget for this field.
652
 */
653 654
function hook_field_widget(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
  $element += array(
655 656 657 658 659 660
    '#type' => $instance['widget']['type'],
    '#default_value' => isset($items[$delta]) ? $items[$delta] : '',
  );
  return $element;
}

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
/**
 * Flag a field-level validation error.
 *
 * @param $element
 *   An array containing the form element for the widget. The error needs to be
 *   flagged on the right sub-element, according to the widget's internal
 *   structure.
 * @param $error
 *   An associative array with the following key-value pairs, as returned by
 *   hook_field_validate():
 *   - 'error': the error code. Complex widgets might need to report different
 *     errors to different form elements inside the widget.
 *   - 'message': the human readable message to be displayed.
 */
function hook_field_widget_error($element, $error) {
  form_error($element['value'], $error['message']);
}

679 680 681 682 683 684 685 686
/**
 * Expose Field API formatter types.
 *
 * Formatters are mainly theme functions that handle the output of individual
 * field values. These theme calls are typically triggered during the execution
 * of drupal_render() on the render structure built by field_attach_view().
 *
 * The name of the theme hook invoked when displaying the values is derived
687 688
 * from formatter type names, using the pattern field_formatter_FORMATTER_NAME.
 * field.module takes care of exposing the corresponding theme functions
689
 * through hook_theme(). Specifically, field.module defines the theme
690 691 692 693
 * hook:
 *
 * @code
 *   'field_formatter_FORMATTER_NAME' => array(
694
 *     'render_element' => 'element',
695 696 697 698 699
 *   )
 * @code
 *
 * If a formatter requires a different theme hook definition,
 * implement hook_theme_registry_alter().
700 701 702 703
 *
 * @see hook_field_formatter_info().
 * @see hook_field_formatter_info_alter().
 * @see theme_field_formatter_FORMATTER_NAME().
704 705
 * @see hook_theme().
 * @see hook_theme_registry_alter().
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
 *
 * @return
 *   An array describing the formatter types implemented by the module.
 *
 *   The keys are formatter type names. To avoid name clashes, formatter type
 *   names should be prefixed with the name of the module that exposes them.
 *
 *   The values are arrays describing the formatter type, with the following
 *   key/value pairs:
 *   - label: The human-readable name of the formatter type.
 *   - description: A short description for the formatter type.
 *   - field types: An array of field types the formatter supports.
 *   - settings: An array whose keys are the names of the settings available
 *     for the formatter type, and whose values are the default values for
 *     those settings.
 *   - behaviors: (optional) An array describing behaviors of the formatter.
 *     - multiple values:
 *       FIELD_BEHAVIOR_DEFAULT (default) if the formatter displays one single
 *       field value (most common case). The formatter theme will be invoked
 *       iteratively on each of the field valies.
 *       FIELD_BEHAVIOR_CUSTOM if one single invocation of the formatter theme
 *       takes care of displays all the field values. Examples: points on
 *       a generated graph picture, a Google map, a single link to a popup...
 */
function hook_field_formatter_info() {
  return array(
    'text_default' => array(
      'label' => t('Default'),
      'field types' => array('text', 'text_long', 'text_with_summary'),
      'behaviors' => array(
        'multiple values' => FIELD_BEHAVIOR_DEFAULT,
      ),
    ),
    'text_plain' => array(
      'label' => t('Plain text'),
      'field types' => array('text', 'text_long', 'text_with_summary'),
      'behaviors' => array(
        'multiple values' => FIELD_BEHAVIOR_DEFAULT,
      ),
    ),

    // The text_trimmed formatter displays the trimmed version of the
    // full element of the field. It is intended to be used with text
    // and text_long fields. It also works with text_with_summary
    // fields though the text_summary_or_trimmed formatter makes more
    // sense for that field type.
    'text_trimmed' => array(
      'label' => t('Trimmed'),
      'field types' => array('text', 'text_long', 'text_with_summary'),
      'behaviors' => array(
        'multiple values' => FIELD_BEHAVIOR_DEFAULT,
      ),
    ),

    // The 'summary or trimmed' field formatter for text_with_summary
    // fields displays returns the summary element of the field or, if
    // the summary is empty, the trimmed version of the full element
    // of the field.
    'text_summary_or_trimmed' => array(
      'label' => t('Summary or trimmed'),
      'field types' => array('text_with_summary'),
      'behaviors' => array(
        'multiple values' => FIELD_BEHAVIOR_DEFAULT,
      ),
    ),
  );
}


/**
 * Perform alterations on Field API formatter types.
 *
 * @param $info
 *   Array of informations on formatter types exposed by
 *   hook_field_field_formatter_info() implementations.
 */
function hook_field_formatter_info_alter(&$info) {
  // Add a setting to a formatter type.
  $info['text_default']['settings'] += array(
    'mymodule_additional_setting' => 'default value',
  );

  // Let a new field type re-use an existing formatter.
  $info['text_default']['field types'][] = 'my_field_type';
}

/**
 * Theme function for a field formatter.
 *
 * This is an example of a 'single' formatter, displaying one single field
 * value (the hook_field_formatter_info() entry uses
 * 'multiple values' = FIELD_BEHAVIOR_DEFAULT).
 *
799 800 801 802 803 804 805 806 807 808 809 810
 * @param $variables
 *   An associative array containing:
 *   - element: A render structure sub-array, containing the following keys:
 *     - #item: The field value being displayed.
 *     - #delta: The index of the value being displayed within the object's
 *       values for the field.
 *     - #field_name: The name of the field being displayed.
 *     - #bundle: The bundle of the object being displayed.
 *     - #object: The object being displayed.
 *     - #object_type: The type of the object being displayed.
 *     - #formatter: The name of the formatter being used.
 *     - #settings: The array of formatter settings.
811
 */
812
function theme_field_formatter_FORMATTER_SINGLE($variables) {
813
  // This relies on a 'safe' element being prepared in hook_field_sanitize().
814
  return $variables['element']['#item']['safe'];
815 816 817 818 819 820 821 822 823
}

/**
 * Theme function for a field formatter.
 *
 * This is an example of a 'single' formatter, displaying all the field values
 * (the hook_field_formatter_info() entry uses
 * 'multiple values' = FIELD_BEHAVIOR_CUSTOM).
 *
824 825 826 827 828 829 830 831 832 833
 * @param $variables
 *   An associative array containing:
 *   - element: A render structure sub-array, containing the following keys:
 *     - #field_name: The name of the field being displayed.
 *     - #bundle: The bundle of the object being displayed.
 *     - #object: The object being displayed.
 *     - #object_type: The type of the object being displayed.
 *     - #formatter: The name of the formatter being used.
 *     - #settings: The array of formatter settings.
 *     - numeric indexes: the field values being displayed.
834
 */
835 836 837
function theme_field_formatter_FORMATTER_MULTIPLE($variables) {
  $element = $variables['element'];

838 839 840 841 842 843 844 845
  $items = array();
  foreach (element_children($element) as $key) {
    $items[$key] = $key .':'. $element[$key]['#item']['value'];
  }
  $output = implode('|', $items);
  return $output;
}

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
/**
 * Allow formatters to load information for multiple objects.
 *
 * This should be used when a formatter needs to load additional information
 * from the database in order to render a field, for example a reference field
 * which displays properties of the referenced objects such as name or type.
 *
 * @param $obj_type
 *   The type of $object.
 * @param $objects
 *   Array of objects being displayed, keyed by object id.
 * @param $field
 *   The field structure for the operation.
 * @param $instances
 *   Array of instance structures for $field for each object, keyed by object id.
 * @param $langcode
 *   The language the field values are to be shown in. If no language is
 *   provided the current language is used.
 * @param $items
 *   Array of field values for the objects, keyed by object id.
 * @return
 *   Changes or additions to field values are done by altering the $items
 *   parameter by reference.
 */
function hook_field_formatter_prepare_view($obj_type, $objects, $field, $instances, $langcode, &$items, $build_mode) {

}

874 875 876 877 878 879 880 881 882 883
/**
 * @} End of "ingroup field_type"
 */

/**
 * @ingroup field_attach
 * @{
 */

/**
884
 * Act on field_attach_form.
885
 *
886
 * This hook is invoked after the field module has performed the operation.
887 888 889
 *
 * See field_attach_form() for details and arguments.
 */
890
function hook_field_attach_form($obj_type, $object, &$form, &$form_state, $langcode) {
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
  $tids = array();

  // Collect every possible term attached to any of the fieldable entities.
  foreach ($objects as $id => $object) {
    foreach ($items[$id] as $delta => $item) {
      // Force the array key to prevent duplicates.
      $tids[$item['value']] = $item['value'];
    }
  }
  if ($tids) {
    $terms = array();

    // Avoid calling taxonomy_term_load_multiple because it could lead to
    // circular references.
    $query = db_select('taxonomy_term_data', 't');
    $query->fields('t');
    $query->condition('t.tid', $tids, 'IN');
    $query->addTag('term_access');
    $terms = $query->execute()->fetchAllAssoc('tid');

    // Iterate through the fieldable entities again to attach the loaded term data.
    foreach ($objects as $id => $object) {
      foreach ($items[$id] as $delta => $item) {
        // Check whether the taxonomy term field instance value could be loaded.
        if (isset($terms[$item['value']])) {
          // Replace the instance value with the term data.
          $items[$id][$delta]['taxonomy_term'] = $terms[$item['value']];
        }
        // Otherwise, unset the instance value, since the term does not exist.
        else {
          unset($items[$id][$delta]);
        }
      }
    }
  }
926 927 928
}

/**
929
 * Act on field_attach_load.
930
 *
931
 * This hook is invoked after the field module has performed the operation.
932
 *
933
 * Unlike other field_attach hooks, this hook accounts for 'multiple loads'.
934 935 936
 * Instead of the usual $object parameter, it accepts an array of objects,
 * indexed by object id. For performance reasons, information for all available
 * objects should be loaded in a single query where possible.
937
 *
938 939 940 941 942 943 944
 * Note that $objects might not be full-fledged 'objects'. When invoked through
 * field_attach_query(), each object only includes properties that the Field
 * API knows about: bundle, id, revision id, and field values (no node title,
 * user name...)

 * The changes made to the objects' field values get cached by the field cache
 * for subsequent loads.
945
 *
946
 * See field_attach_load() for details and arguments.
947
 */
948
function hook_field_attach_load($obj_type, $objects, $age) {
949 950 951
}

/**
952
 * Act on field_attach_validate.
953
 *
954
 * This hook is invoked after the field module has performed the operation.
955 956 957
 *
 * See field_attach_validate() for details and arguments.
 */
958
function hook_field_attach_validate($obj_type, $object, &$errors) {
959 960 961
}

/**
962
 * Act on field_attach_submit.
963
 *
964
 * This hook is invoked after the field module has performed the operation.
965 966 967 968 969 970 971
 *
 * See field_attach_submit() for details and arguments.
 */
function hook_field_attach_submit($obj_type, $object, $form, &$form_state) {
}

/**
972
 * Act on field_attach_presave.
973
 *
974
 * This hook is invoked after the field module has performed the operation.
975 976 977 978 979 980 981
 *
 * See field_attach_presave() for details and arguments.
 */
function hook_field_attach_presave($obj_type, $object) {
}

/**
982
 * Act on field_attach_insert.
983
 *
984
 * This hook is invoked after the field module has performed the operation.
985
 *
986
 * See field_attach_insert() for details and arguments.
987
 */
988
function hook_field_attach_insert($obj_type, $object) {
989 990 991
}

/**
992
 * Act on field_attach_update.
993
 *
994
 * This hook is invoked after the field module has performed the operation.
995
 *
996
 * See field_attach_update() for details and arguments.
997
 */
998
function hook_field_attach_update($obj_type, $object) {
999 1000
}

1001
/**
1002
 * Act on field_attach_preprocess.
1003
 *
1004
 * This hook is invoked while preprocessing the field.tpl.php template file.
1005
 *
1006 1007 1008 1009 1010 1011 1012 1013
 * @param $variables
 *   The variables array is passed by reference and will be populated with field
 *   values.
 * @param $context
 *   An associative array containing:
 *   - obj_type: The type of $object; e.g. 'node' or 'user'.
 *   - object: The object with fields to render.
 *   - element: The structured array containing the values ready for rendering.
1014
 */
1015
function hook_field_attach_preprocess_alter(&$variables, $context) {
1016 1017
}

1018
/**
1019
 * Act on field_attach_delete.
1020
 *
1021
 * This hook is invoked after the field module has performed the operation.
1022 1023 1024 1025 1026 1027 1028
 *
 * See field_attach_delete() for details and arguments.
 */
function hook_field_attach_delete($obj_type, $object) {
}

/**
1029
 * Act on field_attach_delete_revision.
1030
 *
1031
 * This hook is invoked after the field module has performed the operation.
1032 1033 1034 1035 1036 1037 1038
 *
 * See field_attach_delete_revision() for details and arguments.
 */
function hook_field_attach_delete_revision($obj_type, $object) {
}

/**
1039
 * Act on field_attach_view.
1040
 *
1041
 * This hook is invoked after the field module has performed the operation.
1042
 *
1043 1044 1045 1046 1047 1048 1049 1050
 * @param &$output
 *   The structured content array tree for all of $object's fields.
 * @param $context
 *   An associative array containing:
 *   - obj_type: The type of $object; e.g. 'node' or 'user'.
 *   - object: The object with fields to render.
 *   - build_mode: Build mode, e.g. 'full', 'teaser'...
 *   - langcode: The language in which the field values will be displayed.
1051
 */
1052
function hook_field_attach_view_alter(&$output, $context) {
1053 1054 1055
}

/**
1056
 * Act on field_attach_create_bundle.
1057
 *
1058
 * This hook is invoked after the field module has performed the operation.
1059 1060 1061
 *
 * See field_attach_create_bundle() for details and arguments.
 */
1062
function hook_field_attach_create_bundle($obj_type, $bundle) {
1063 1064 1065
}

/**
1066
 * Act on field_attach_rename_bundle.
1067
 *
1068
 * This hook is invoked after the field module has performed the operation.
1069 1070 1071
 *
 * See field_attach_rename_bundle() for details and arguments.
 */
1072
function hook_field_attach_rename_bundle($obj_type, $bundle_old, $bundle_new) {
1073 1074 1075
}

/**
1076
 * Act on field_attach_delete_bundle.
1077
 *
1078
 * This hook is invoked after the field module has performed the operation.
1079
 *
1080 1081
 * @param $obj_type
 *   The type of object; e.g. 'node' or 'user'.
1082 1083 1084
 * @param $bundle
 *   The bundle that was just deleted.
 * @param $instances
1085
 *   An array of all instances that existed for the bundle before it was
1086
 *   deleted.
1087
 */
1088
function hook_field_attach_delete_bundle($obj_type, $bundle, $instances) {
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
}

/**
 * @} End of "ingroup field_attach"
 */

/**********************************************************************
 * Field Storage API
 **********************************************************************/

/**
 * @ingroup field_storage
 * @{
 */

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
/**
 * Expose Field API storage backends.
 *
 * @return
 *   An array describing the storage backends implemented by the module.
 *   The keys are storage backend names. To avoid name clashes, storage backend
 *   names should be prefixed with the name of the module that exposes them.
 *   The values are arrays describing the storage backend, with the following
 *   key/value pairs:
 *   - label: The human-readable name of the storage backend.
 *   - description: A short description for the storage backend.
 *   - settings: An array whose keys are the names of the settings available
 *     for the storage backend, and whose values are the default values for
 *     those settings.
 */
function hook_field_storage_info() {
  return array(
    'field_sql_storage' => array(
      'label' => t('Default SQL storage'),
      'description' => t('Stores fields in the local SQL database, using per-field tables.'),
      'settings' => array(),
    ),
  );
}

/**
 * Perform alterations on Field API storage types.
 *
 * @param $info
 *   Array of informations on storage types exposed by
 *   hook_field_field_storage_info() implementations.
 */
function hook_field_storage_info_alter(&$info) {
  // Add a setting to a storage type.
  $info['field_sql_storage']['settings'] += array(
    'mymodule_additional_setting' => 'default value',
  );
}

1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
/**
 * Reveal the internal details about the storage for a field.
 *
 * For example, an SQL storage module might return the Schema API structure for
 * the table. A key/value storage module might return the server name,
 * authentication credentials, and bin name.
 *
 * Field storage modules are not obligated to implement this hook. Modules
 * that rely on these details must only use them for read operations.
 *
 * @param $field
 *   A field structure.
 * @param $instance
 *   A field instance structure.
 * @return
 *   An array of details.
 *    - The first dimension is a store type (sql, solr, etc).
 *    - The second dimension indicates the age of the values in the store
 *      FIELD_LOAD_CURRENT or FIELD_LOAD_REVISION.
 *    - Other dimensions are specific to the field storage module.
 */
function hook_field_storage_details($field, $instance) {
}

/**
 * Perform alterations on Field API storage details.
 *
 * The storage details are appended to the field instance structure after this
 * hook is invoked. Read and alter the $details only.
 *
 * @param $details
 *   An array of storage details for fields as exposed by
 *   hook_field_storage_details() implementations.
 * @param $field
 *   A field structure.
 * @param $instance
 *   A field instance structure.
 */
function hook_field_storage_details_alter(&$details, $field, $instance) {
}

1184 1185 1186 1187
/**
 * Load field data for a set of objects.
 *
 * @param $obj_type
1188
 *   The entity type of object, such as 'node' or 'user'.
1189
 * @param $objects
1190
 *   The array of objects for which to load data, keyed by object id.
1191 1192 1193 1194
 * @param $age
 *   FIELD_LOAD_CURRENT to load the most recent revision for all
 *   fields, or FIELD_LOAD_REVISION to load the version indicated by
 *   each object.
1195 1196 1197 1198
 * @param $fields
 *   An array listing the fields to be loaded. The keys of the array are field
 *   ids, the values of the array are the object ids (or revision ids,
 *   depending on the $age parameter) to be loaded for each field.
1199
 * @return
1200 1201
 *   Loaded field values are added to $objects. Fields with no values should be
 *   set as an empty array.
1202
 */
1203
function hook_field_storage_load($obj_type, $objects, $age, $fields) {
1204 1205 1206 1207 1208 1209 1210 1211 1212
}

/**
 * Write field data for an object.
 *
 * @param $obj_type
 *   The entity type of object, such as 'node' or 'user'.
 * @param $object
 *   The object on which to operate.
1213 1214 1215
 * @param $op
 *   FIELD_STORAGE_UPDATE when updating an existing object,
 *   FIELD_STORAGE_INSERT when inserting a new object.
1216 1217 1218
 * @param $fields
 *   An array listing the fields to be written. The keys and values of the
 *   array are field ids.
1219
 */
1220
function hook_field_storage_write($obj_type, $object, $op, $fields) {
1221 1222 1223 1224 1225 1226 1227 1228 1229
}

/**
 * Delete all field data for an object.
 *
 * @param $obj_type
 *   The entity type of object, such as 'node' or 'user'.
 * @param $object
 *   The object on which to operate.
1230 1231 1232
 * @param $fields
 *   An array listing the fields to delete. The keys and values of the
 *   array are field ids.
1233
 */
1234
function hook_field_storage_delete($obj_type, $object, $fields) {
1235 1236 1237 1238 1239
}

/**
 * Delete a single revision of field data for an object.
 *
1240 1241 1242
 * Deleting the current (most recently written) revision is not
 * allowed as has undefined results.
 *
1243 1244 1245
 * @param $obj_type
 *   The entity type of object, such as 'node' or 'user'.
 * @param $object
1246
 *   The object on which to operate. The revision to delete is
1247 1248
 *   indicated by the object's revision id property, as identified by
 *   hook_fieldable_info() for $obj_type.
1249 1250 1251
 * @param $fields
 *   An array listing the fields to delete. The keys and values of the
 *   array are field ids.
1252
 */
1253
function hook_field_storage_delete_revision($obj_type, $object, $fields) {
1254 1255
}

1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
/**
 * Handle a field query.
 *
 * @param $field_name
 *   The name of the field to query.
 * @param $conditions
 *   See field_attach_query().
 *   A storage module that doesn't support querying a given column should raise
 *   a FieldQueryException. Incompatibilities should be mentioned on the module
 *   project page.
1266 1267
 * @param $options
 *   See field_attach_query(). All option keys are guaranteed to be specified.
1268 1269 1270
 * @return
 *   See field_attach_query().
 */
1271
function hook_field_storage_query($field_name, $conditions, $options) {
1272 1273
}

1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
/**
 * Act on creation of a new field.
 *
 * @param $field
 *   The field structure being created.
 */
function hook_field_storage_create_field($field) {
}

/**
 * Act on deletion of a field.
 *
1286 1287
 * @param $field
 *   The field being deleted.
1288
 */
1289
function hook_field_storage_delete_field($field) {
1290 1291 1292 1293 1294
}

/**
 * Act on deletion of a field instance.
 *
1295 1296
 * @param $instance
 *   The instance being deleted.
1297
 */
1298
function hook_field_storage_delete_instance($instance) {
1299 1300
}

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
/**
 * Act before the storage backends load field data.
 *
 * This hook allows modules to load data before the Field Storage API,
 * optionally preventing the field storage module from doing so.
 *
 * This lets 3rd party modules override, mirror, shard, or otherwise store a
 * subset of fields in a different way than the current storage engine.
 * Possible use cases include: per-bundle storage, per-combo-field storage...
 *
 * @param $obj_type
 *   The type of objects for which to load fields; e.g. 'node' or 'user'.
 * @param $objects
 *   An array of objects for which to load fields, keyed by object id.
 * @param $age
 *   FIELD_LOAD_CURRENT to load the most recent revision for all fields, or
 *   FIELD_LOAD_REVISION to load the version indicated by each object.
 * @param $skip_fields
 *   An array keyed by field ids whose data has already been loaded and
 *   therefore should not be loaded again. The values associated to these keys
 *   are not specified.
 * @return
 *   - Loaded field values are added to $objects. Fields with no values should
 *     be set as an empty array.
 *   - Loaded field ids are set as keys in $skip_fields.
 */
function hook_field_storage_pre_load($obj_type, $objects, $age, &$skip_fields) {
}

/**
 * Act before the storage backends insert field data.
 *
 * This hook allows modules to store data before the Field Storage API,
 * optionally preventing the field storage module from doing so.
 *
 * @param $obj_type
 *   The type of $object; e.g. 'node' or 'user'.
 * @param $object
 *   The object with fields to save.
 * @param $skip_fields
 *   An array keyed by field ids whose data has already been written and
 *   therefore should not be written again. The values associated to these keys
 *   are not specified.
 * @return
 *   Saved field ids are set set as keys in $skip_fields.
 */
function hook_field_storage_pre_insert($obj_type, $object, &$skip_fields) {
  if ($obj_type == 'node' && $object->status && _forum_node_check_node_type($object)) {
    $query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
    foreach ($object->taxonomy_forums as $language) {
      foreach ($language as $delta) {
        $query->values(array(
          'nid' => $object->nid,
          'title' => $object->title[FIELD_LANGUAGE_NONE][0]['value'],
          'tid' => $delta['value'],
          'sticky' => $object->sticky,
          'created' => $object->created,
          'comment_count' => 0,
          'last_comment_timestamp' => $object->created,
        ));
      }
    }
    $query->execute();
  }
}

/**
 * Act before the storage backends update field data.
 *
 * This hook allows modules to store data before the Field Storage API,
 * optionally preventing the field storage module from doing so.
 *
 * @param $obj_type
 *   The type of $object; e.g. 'node' or 'user'.
 * @param $object
 *   The object with fields to save.
 * @param $skip_fields
 *   An array keyed by field ids whose data has already been written and
 *   therefore should not be written again. The values associated to these keys
 *   are not specified.
 * @return
 *   Saved field ids are set set as keys in $skip_fields.
 */
function hook_field_storage_pre_update($obj_type, $object, &$skip_fields) {
  $first_call = &drupal_static(__FUNCTION__, array());

  if ($obj_type == 'node' && $object->status && _forum_node_check_node_type($object)) {
    // We don't maintain data for old revisions, so clear all previous values
    // from the table. Since this hook runs once per field, per object, make
    // sure we only wipe values once.
    if (!isset($first_call[$object->nid])) {
      $first_call[$object->nid] = FALSE;
      db_delete('forum_index')->condition('nid', $object->nid)->execute();
    }
    // Only save data to the table if the node is published.
    if ($object->status) {
      $query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
      foreach ($object->taxonomy_forums as $language) {
        foreach ($language as $delta) {
          $query->values(array(
            'nid' => $object->nid,
            'title' => $object->title,
            'tid' => $delta['value'],
            'sticky' => $object->sticky,
            'created' => $object->created,
            'comment_count' => 0,
            'last_comment_timestamp' => $object->created,
          ));
        }
      }
      $query->execute();
      // The logic for determining last_comment_count is fairly complex, so
      // call _forum_update_forum_index() too.
      _forum_update_forum_index($object->nid);
    }
  }
}

/**
 * Act before the storage backend runs the query.
 *
 * This hook should be implemented by modules that use
 * hook_field_storage_pre_load(), hook_field_storage_pre_insert() and
 * hook_field_storage_pre_update() to bypass the regular storage engine, to
 * handle field queries.
 *
 * @param $field_name
 *   The name of the field to query.
 * @param $conditions
 *   See field_attach_query().
 *   A storage module that doesn't support querying a given column should raise
 *   a FieldQueryException. Incompatibilities should be mentioned on the module
 *   project page.
 * @param $options
 *   See field_attach_query(). All option keys are guaranteed to be specified.
 * @param $skip_field
 *   Boolean, always coming as FALSE.
 * @return
 *   See field_attach_query().
 *   The $skip_field parameter should be set to TRUE if the query has been
 *   handled.
 */
function hook_field_storage_pre_query($field_name, $conditions, $options, &$skip_field) {
}

1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
/**
 * @} End of "ingroup field_storage"
 */

/**********************************************************************
 * Field CRUD API
 **********************************************************************/

/**
 * @ingroup field_crud
 * @{
 */

/**
1460
 * Act on a field being created.
1461
 *
1462 1463
 * This hook is invoked after the field is created and so it cannot modify the
 * field itself.
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
 *
 * TODO: Not implemented.
 *
 * @param $field
 *   The field just created.
 */
function hook_field_create_field($field) {
}

/**
1474
 * Act on a field instance being created.
1475
 *
1476 1477
 * This hook is invoked after the instance record is saved and so it cannot
 * modify the instance itself.
1478 1479 1480 1481 1482 1483 1484
 *
 * @param $instance
 *   The instance just created.
 */
function hook_field_create_instance($instance) {
}

1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
/**
 * Forbid a field update from occurring.
 *
 * Any module may forbid any update for any reason. For example, the
 * field's storage module might forbid an update if it would change
 * the storage schema while data for the field exists. A field type
 * module might forbid an update if it would change existing data's
 * semantics, or if there are external dependencies on field settings
 * that cannot be updated.
 *
 * @param $field
 *   The field as it will be post-update.
 * @param $prior_field
 *   The field as it is pre-update.
 * @param $has_data
 *   Whether any data already exists for this field.
 * @return
1502
 *   Throws a FieldUpdateForbiddenException to prevent the update from occuring.
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
 */
function hook_field_update_field_forbid($field, $prior_field, $has_data) {
  // A 'list' field stores integer keys mapped to display values. If
  // the new field will have fewer values, and any data exists for the
  // abandonded keys, the field will have no way to display them. So,
  // forbid such an update.
  if ($has_data && count($field['settings']['allowed_values']) < count($prior_field['settings']['allowed_values'])) {
    // Identify the keys that will be lost.
    $lost_keys = array_diff(array_keys($field['settings']['allowed_values']), array_keys($prior_field['settings']['allowed_values']));
    // If any data exist for those keys, forbid the update.
    $count = field_attach_query($prior_field['id'], array('value', $lost_keys, 'IN'), 1);
    if ($count > 0) {
1515
      throw new FieldUpdateForbiddenException("Cannot update a list field not to include keys with existing data");
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
    }
  }
}

/**
 * Act on a field being updated.
 *
 * This hook is invoked just after field is updated.
 *
 * @param $field
 *   The field as it is post-update.
 * @param $prior_field
 *   The field as it was pre-update.
 * @param $has_data
 *   Whether any data already exists for this field.
 */
function hook_field_update_field($field, $prior_field, $has_data) {
}

1535
/**
1536
 * Act on a field being deleted.
1537
 *
1538
 * This hook is invoked just after field is deleted.
1539 1540
 *
 * @param $field
1541
 *   The field just deleted.
1542 1543 1544 1545 1546
 */
function hook_field_delete_field($field) {
}

/**
1547
 * Act on a field instance being updated.
1548
 *
1549 1550
 * This hook is invoked after the instance record is saved and so it cannot
 * modify the instance itself.
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
 *
 * TODO: Not implemented.
 *
 * @param $instance
 *   The instance just updated.
 */
function hook_field_update_instance($instance) {
}

/**
1561
 * Act on a field instance being deleted.
1562
 *
1563
 * This hook is invoked just after the instance is deleted.
1564 1565
 *
 * @param $instance
1566
 *   The instance just deleted.
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615
 */
function hook_field_delete_instance($instance) {
}

/**
 * Act on field records being read from the database.
 *
 * @param $field
 *   The field record just read from the database.
 */
function hook_field_read_field($field) {
}

/**
 * Act on a field record being read from the database.
 *
 * @param $instance
 *   The instance record just read from the database.
 */
function hook_field_read_instance($instance) {
}

/**
 * @} End of "ingroup field_crud"
 */

/**********************************************************************
 * TODO: I'm not sure where these belong yet.
 **********************************************************************/

/**
 * TODO
 *
 * Note : Right now this belongs to the "Fieldable Type API".
 * Whether 'build modes' is actually a 'fields' concept is to be debated
 * in a separate overhaul patch for core.
 */
function hook_field_build_modes($obj_type) {
}

/**
 * Determine whether the user has access to a given field.
 *
 * @param $op
 *   The operation to be performed. Possible values:
 *   - "edit"
 *   - "view"
 * @param $field
 *   The field on which the operation is to be performed.
1616 1617 1618 1619
 * @param $obj_type
 *   The type of $object; e.g. 'node' or 'user'.
 * @param $object
 *   (optional) The object for the operation.
1620 1621 1622 1623 1624 1625
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
 * @return
 *   TRUE if the operation is allowed;
 *   FALSE if the operation is denied.
 */
1626
function hook_field_access($op, $field, $obj_type, $object, $account) {
1627
}