node.api.php 35.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<?php
// $Id$

/**
 * @file
 * Hooks provided by the Node module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Inform the node access system what permissions the user has.
 *
17 18 19 20
 * This hook is for implementation by node access modules. In this hook,
 * the module grants a user different "grant IDs" within one or more
 * "realms". In hook_node_access_records(), the realms and grant IDs are
 * associated with permission to view, edit, and delete individual nodes.
21
 *
22 23 24 25 26
 * The realms and grant IDs can be arbitrarily defined by your node access
 * module; it is common to use role IDs as grant IDs, but that is not
 * required. Your module could instead maintain its own list of users, where
 * each list has an ID. In that case, the return value of this hook would be
 * an array of the list IDs that this user is a member of.
27 28 29 30
 *
 * A node access module may implement as many realms as necessary to
 * properly define the access privileges for the nodes.
 *
31
 * @param $account
32 33 34
 *   The user object whose grants are requested.
 * @param $op
 *   The node operation to be performed, such as "view", "update", or "delete".
35
 *
36
 * @return
37 38
 *   An array whose keys are "realms" of grants, and whose values are arrays of
 *   the grant IDs within this realm that this user is being granted.
39 40 41 42 43 44 45 46 47
 *
 * For a detailed example, see node_access_example.module.
 *
 * @ingroup node_access
 */
function hook_node_grants($account, $op) {
  if (user_access('access private content', $account)) {
    $grants['example'] = array(1);
  }
48
  $grants['example_owner'] = array($account->uid);
49 50 51 52 53 54
  return $grants;
}

/**
 * Set permissions for a node to be written to the database.
 *
55 56 57
 * When a node is saved, a module implementing hook_node_access_records() will
 * be asked if it is interested in the access permissions for a node. If it is
 * interested, it must respond with an array of permissions arrays for that
58 59
 * node.
 *
60 61 62
 * Note that the grant values in the return value from your hook must be
 * integers and not boolean TRUE and FALSE.
 *
63 64 65 66
 * Each permissions item in the array is an array with the following elements:
 * - 'realm': The name of a realm that the module has defined in
 *   hook_node_grants().
 * - 'gid': A 'grant ID' from hook_node_grants().
67
 * - 'grant_view': If set to 1 a user that has been identified as a member
68
 *   of this gid within this realm can view this node.
69
 * - 'grant_update': If set to 1 a user that has been identified as a member
70
 *   of this gid within this realm can edit this node.
71
 * - 'grant_delete': If set to 1 a user that has been identified as a member
72 73 74 75 76
 *   of this gid within this realm can delete this node.
 * - 'priority': If multiple modules seek to set permissions on a node, the
 *   realms that have the highest priority will win out, and realms with a lower
 *   priority will not be written. If there is any doubt, it is best to
 *   leave this 0.
77 78 79
 *
 * @ingroup node_access
 */
80
function hook_node_access_records($node) {
81 82 83 84
  if (node_access_example_disabling()) {
    return;
  }

85
  // We only care about the node if it has been marked private. If not, it is
86 87 88 89 90
  // treated just like any other node and we completely ignore it.
  if ($node->private) {
    $grants = array();
    $grants[] = array(
      'realm' => 'example',
91 92 93 94
      'gid' => 1,
      'grant_view' => 1,
      'grant_update' => 0,
      'grant_delete' => 0,
95 96 97 98 99 100 101 102
      'priority' => 0,
    );

    // For the example_author array, the GID is equivalent to a UID, which
    // means there are many many groups of just 1 user.
    $grants[] = array(
      'realm' => 'example_author',
      'gid' => $node->uid,
103 104 105
      'grant_view' => 1,
      'grant_update' => 1,
      'grant_delete' => 1,
106 107 108 109 110 111
      'priority' => 0,
    );
    return $grants;
  }
}

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/**
 * Alter permissions for a node before it is written to the database.
 *
 * Node access modules establish rules for user access to content. Node access
 * records are stored in the {node_access} table and define which permissions
 * are required to access a node. This hook is invoked after node access modules
 * returned their requirements via hook_node_access_records(); doing so allows
 * modules to modify the $grants array by reference before it is stored, so
 * custom or advanced business logic can be applied.
 *
 * @see hook_node_access_records()
 *
 * Upon viewing, editing or deleting a node, hook_node_grants() builds a
 * permissions array that is compared against the stored access records. The
 * user must have one or more matching permissions in order to complete the
 * requested operation.
 *
 * @see hook_node_grants()
 * @see hook_node_grants_alter()
 *
 * @param &$grants
 *   The $grants array returned by hook_node_access_records().
 * @param $node
 *   The node for which the grants were acquired.
 *
 * The preferred use of this hook is in a module that bridges multiple node
138 139
 * access modules with a configurable behavior, as shown in the example with the
 * 'is_preview' field.
140 141 142
 *
 * @ingroup node_access
 */
143
function hook_node_access_records_alter(&$grants, $node) {
144 145 146 147 148 149 150 151 152
  // Our module allows editors to mark specific articles with the 'is_preview'
  // field. If the node being saved has a TRUE value for that field, then only
  // our grants are retained, and other grants are removed. Doing so ensures
  // that our rules are enforced no matter what priority other grants are given.
  if ($node->is_preview) {
    // Our module grants are set in $grants['example'].
    $temp = $grants['example'];
    // Now remove all module grants but our own.
    $grants = array('example' => $temp);
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
  }
}

/**
 * Alter user access rules when trying to view, edit or delete a node.
 *
 * Node access modules establish rules for user access to content.
 * hook_node_grants() defines permissions for a user to view, edit or
 * delete nodes by building a $grants array that indicates the permissions
 * assigned to the user by each node access module. This hook is called to allow
 * modules to modify the $grants array by reference, so the interaction of
 * multiple node access modules can be altered or advanced business logic can be
 * applied.
 *
 * @see hook_node_grants()
 *
 * The resulting grants are then checked against the records stored in the
 * {node_access} table to determine if the operation may be completed.
 *
 * @see hook_node_access_records()
 * @see hook_node_access_records_alter()
 *
 * @param &$grants
 *   The $grants array returned by hook_node_grants().
 * @param $account
 *   The user account requesting access to content.
 * @param $op
 *   The operation being performed, 'view', 'update' or 'delete'.
 *
 * Developers may use this hook to either add additional grants to a user
 * or to remove existing grants. These rules are typically based on either the
 * permissions assigned to a user role, or specific attributes of a user
 * account.
 *
 * @ingroup node_access
 */
function hook_node_grants_alter(&$grants, $account, $op) {
  // Our sample module never allows certain roles to edit or delete
  // content. Since some other node access modules might allow this
  // permission, we expressly remove it by returning an empty $grants
  // array for roles specified in our variable setting.

  // Get our list of banned roles.
  $restricted = variable_get('example_restricted_roles', array());
197

198 199 200 201 202 203 204 205 206 207
  if ($op != 'view' && !empty($restricted)) {
    // Now check the roles for this account against the restrictions.
    foreach ($restricted as $role_id) {
      if (isset($user->roles[$role_id])) {
        $grants = array();
      }
    }
  }
}

208 209 210
/**
 * Add mass node operations.
 *
211 212 213 214 215
 * This hook enables modules to inject custom operations into the mass
 * operations dropdown found at admin/content, by associating a callback
 * function with the operation, which is called when the form is submitted. The
 * callback function receives one initial argument, which is an array of the
 * checked nodes.
216 217 218 219
 *
 * @return
 *   An array of operations. Each operation is an associative array that may
 *   contain the following key-value pairs:
220 221 222 223 224
 *   - 'label': Required. The label for the operation, displayed in the dropdown
 *     menu.
 *   - 'callback': Required. The function to call for the operation.
 *   - 'callback arguments': Optional. An array of additional arguments to pass
 *     to the callback function.
225 226 227
 */
function hook_node_operations() {
  $operations = array(
228 229 230 231
    'publish' => array(
      'label' => t('Publish selected content'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED)),
232
    ),
233 234 235 236
    'unpublish' => array(
      'label' => t('Unpublish selected content'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_NOT_PUBLISHED)),
237
    ),
238 239 240 241
    'promote' => array(
      'label' => t('Promote selected content to front page'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED, 'promote' => NODE_PROMOTED)),
242 243
    ),
    'demote' => array(
244 245 246
      'label' => t('Demote selected content from front page'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('promote' => NODE_NOT_PROMOTED)),
247
    ),
248 249 250 251 252 253 254 255 256
    'sticky' => array(
      'label' => t('Make selected content sticky'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED, 'sticky' => NODE_STICKY)),
    ),
    'unsticky' => array(
      'label' => t('Make selected content not sticky'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('sticky' => NODE_NOT_STICKY)),
257 258
    ),
    'delete' => array(
259 260
      'label' => t('Delete selected content'),
      'callback' => NULL,
261 262 263 264 265
    ),
  );
  return $operations;
}

266
/**
267 268 269 270 271
 * Respond to node deletion.
 *
 * This hook is invoked from node_delete_multiple() after the node has been
 * removed from the node table in the database, after the type-specific
 * hook_delete() has been invoked, and before field_attach_delete() is called.
272 273 274 275
 *
 * @param $node
 *   The node that is being deleted.
 */
276
function hook_node_delete($node) {
277 278 279
  db_delete('mytable')
    ->condition('nid', $node->nid)
    ->execute();
280 281 282
}

/**
283
 * Respond to deletion of a node revision.
284
 *
285 286 287
 * This hook is invoked from node_revision_delete() after the revision has been
 * removed from the node_revision table, and before
 * field_attach_delete_revision() is called.
288 289
 *
 * @param $node
290
 *   The node revision (node object) that is being deleted.
291
 */
292
function hook_node_revision_delete($node) {
293 294 295 296 297 298 299 300 301 302
  db_delete('upload')->condition('vid', $node->vid)->execute();
  if (!is_array($node->files)) {
    return;
  }
  foreach ($node->files as $file) {
    file_delete($file);
  }
}

/**
303
 * Respond to creation of a new node.
304
 *
305 306 307
 * This hook is invoked from node_save() after the node is inserted into the
 * node table in the database, after the type-specific hook_insert() is invoked,
 * and after field_attach_insert() is called.
308 309
 *
 * @param $node
310
 *   The node that is being created.
311
 */
312
function hook_node_insert($node) {
313 314 315 316 317 318
  db_insert('mytable')
    ->fields(array(
      'nid' => $node->nid,
      'extra' => $node->extra,
    ))
    ->execute();
319 320
}

321
/**
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
 * Act on nodes being loaded from the database.
 *
 * This hook is invoked during node loading, which is handled by entity_load(),
 * via classes NodeController and DrupalDefaultEntityController. After the node
 * information is read from the database or the entity cache, hook_load() is
 * invoked on the node's content type module, then field_attach_node_revision()
 * or field_attach_load() is called, then hook_entity_load() is invoked on all
 * implementing modules, and finally hook_node_load() is invoked on all
 * implementing modules.
 *
 * This hook should only be used to add information that is not in the node or
 * node revisions table, not to replace information that is in these tables
 * (which could interfere with the entity cache). For performance reasons,
 * information for all available nodes should be loaded in a single query where
 * possible.
 *
 * The $types parameter allows for your module to have an early return (for
 * efficiency) if your module only supports certain node types. However, if your
 * module defines a content type, you can use hook_load() to respond to loading
 * of just that content type.
342 343
 *
 * @param $nodes
344
 *   An array of the nodes being loaded, keyed by nid.
345 346
 * @param $types
 *   An array containing the types of the nodes.
347 348
 *
 * For a detailed usage example, see nodeapi_example.module.
349
 */
350
function hook_node_load($nodes, $types) {
351
  $result = db_query('SELECT nid, foo FROM {mytable} WHERE nid IN(:nids)', array(':nids' => array_keys($nodes)));
352 353 354 355 356
  foreach ($result as $record) {
    $nodes[$record->nid]->foo = $record->foo;
  }
}

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
/**
 * Control access to a node.
 *
 * Modules may implement this hook if they want to have a say in whether or not
 * a given user has access to perform a given operation on a node.
 *
 * The administrative account (user ID #1) always passes any access check,
 * so this hook is not called in that case. Users with the "bypass node access"
 * permission may always view and edit content through the administrative
 * interface.
 *
 * Note that not all modules will want to influence access on all
 * node types. If your module does not want to actively grant or
 * block access, return NODE_ACCESS_IGNORE or simply return nothing.
 * Blindly returning FALSE will break other node access modules.
 *
 * @link http://api.drupal.org/api/group/node_access/7 More on the node access system @endlink
 * @ingroup node_access
 * @param $node
 *   The node on which the operation is to be performed, or, if it does
 *   not yet exist, the type of node to be created.
 * @param $op
 *   The operation to be performed. Possible values:
 *   - "create"
 *   - "delete"
 *   - "update"
 *   - "view"
 * @param $account
 *   A user object representing the user for whom the operation is to be
 *   performed.
387
 *
388 389 390 391 392 393
 * @return
 *   NODE_ACCESS_ALLOW if the operation is to be allowed;
 *   NODE_ACCESS_DENY if the operation is to be denied;
 *   NODE_ACCESSS_IGNORE to not affect this operation at all.
 */
function hook_node_access($node, $op, $account) {
394
  $type = is_string($node) ? $node : $node->type;
395

396
  if (in_array($type, node_permissions_get_configured_types())) {
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
    if ($op == 'create' && user_access('create ' . $type . ' content', $account)) {
      return NODE_ACCESS_ALLOW;
    }

    if ($op == 'update') {
      if (user_access('edit any ' . $type . ' content', $account) || (user_access('edit own ' . $type . ' content', $account) && ($account->uid == $node->uid))) {
        return NODE_ACCESS_ALLOW;
      }
    }

    if ($op == 'delete') {
      if (user_access('delete any ' . $type . ' content', $account) || (user_access('delete own ' . $type . ' content', $account) && ($account->uid == $node->uid))) {
        return NODE_ACCESS_ALLOW;
      }
    }
  }

  // Returning nothing from this function would have the same effect.
  return NODE_ACCESS_IGNORE;
}


419
/**
420 421 422 423
 * Act on a node object about to be shown on the add/edit form.
 *
 * This hook is invoked from node_object_prepare() after the type-specific
 * hook_prepare() is invoked.
424
 *
425
 * @param $node
426
 *   The node that is about to be shown on the add/edit form.
427
 */
428
function hook_node_prepare($node) {
429
  if (!isset($node->comment)) {
430
    $node->comment = variable_get("comment_$node->type", COMMENT_NODE_OPEN);
431 432 433 434
  }
}

/**
435
 * Act on a node object being cloned for translation.
436
 *
437 438 439
 * This hook is invoked from translation_node_prepare() after the node is
 * loaded. $node->language is set to the language being requested, and
 * $node->translation_source is set to the node object being cloned.
440
 *
441
 * @param $node
442
 *   The node object being prepared for translation.
443
 */
444
function hook_node_prepare_translation($node) {
445 446 447
}

/**
448
 * Act on a node being displayed as a search result.
449
 *
450
 * This hook is invoked from node_search_execute(), after node_load()
451
 * and node_view() have been called.
452 453
 *
 * @param $node
454 455
 *   The node being displayed in a search result.
 *
456 457 458
 * @return
 *   Extra information to be displayed with search result.
 */
459
function hook_node_search_result($node) {
460 461 462 463 464
  $comments = db_query('SELECT comment_count FROM {node_comment_statistics} WHERE nid = :nid', array('nid' => $node->nid))->fetchField();
  return format_plural($comments, '1 comment', '@count comments');
}

/**
465
 * Act on a node being inserted or updated.
466
 *
467 468
 * This hook is invoked from node_save() before the node is saved to the
 * database.
469 470
 *
 * @param $node
471
 *   The node that is being inserted or updated.
472
 */
473
function hook_node_presave($node) {
474 475 476 477 478 479 480 481 482
  if ($node->nid && $node->moderate) {
    // Reset votes when node is updated:
    $node->score = 0;
    $node->users = '';
    $node->votes = 0;
  }
}

/**
483 484 485 486 487
 * Respond to updates to a node.
 *
 * This hook is invoked from node_save() after the node is updated in the node
 * table in the database, after the type-specific hook_update() is invoked, and
 * after field_attach_update() is called.
488 489
 *
 * @param $node
490
 *   The node that is being updated.
491
 */
492
function hook_node_update($node) {
493 494 495 496
  db_update('mytable')
    ->fields(array('extra' => $node->extra))
    ->condition('nid', $node->nid)
    ->execute();
497 498 499
}

/**
500
 * Act on a node being indexed for searching.
501
 *
502
 * This hook is invoked during search indexing, after node_load(), and after
503
 * the result of node_view() is added as $node->rendered to the node object.
504 505
 *
 * @param $node
506 507
 *   The node being indexed.
 *
508 509 510
 * @return
 *   Array of additional information to be indexed.
 */
511
function hook_node_update_index($node) {
512 513 514
  $text = '';
  $comments = db_query('SELECT subject, comment, format FROM {comment} WHERE nid = :nid AND status = :status', array(':nid' => $node->nid, ':status' => COMMENT_PUBLISHED));
  foreach ($comments as $comment) {
515
    $text .= '<h2>' . check_plain($comment->subject) . '</h2>' . check_markup($comment->comment, $comment->format, '', TRUE);
516 517 518 519 520
  }
  return $text;
}

/**
521 522 523 524 525 526
 * Perform node validation before a node is created or updated.
 *
 * This hook is invoked from node_validate(), after a user has has finished
 * editing the node and is previewing or submitting it. It is invoked at the
 * end of all the standard validation steps, and after the type-specific
 * hook_validate() is invoked.
527
 *
528 529 530 531 532 533
 * To indicate a validation error, use form_set_error().
 *
 * Note: Changes made to the $node object within your hook implementation will
 * have no effect.  The preferred method to change a node's content is to use
 * hook_node_presave() instead. If it is really necessary to change
 * the node at the validate stage, you can use form_set_value().
534 535
 *
 * @param $node
536
 *   The node being validated.
537
 * @param $form
538
 *   The form being used to edit the node.
539
 */
540
function hook_node_validate($node, $form) {
541 542 543 544 545 546 547 548
  if (isset($node->end) && isset($node->start)) {
    if ($node->start > $node->end) {
      form_set_error('time', t('An event may not end before it starts.'));
    }
  }
}

/**
549
 * Act on a node that is being assembled before rendering.
550
 *
551 552 553 554
 * The module may add elements to $node->content prior to rendering. This hook
 * will be called after hook_view(). The structure of $node->content is a
 * renderable array as expected by drupal_render().
 *
555
 * When $view_mode is 'rss', modules can also add extra RSS elements and
556 557 558
 * namespaces to $node->rss_elements and $node->rss_namespaces respectively for
 * the RSS item generated for this node.
 * For details on how this is used @see node_feed()
559 560 561 562
 *
 * @see taxonomy_node_view()
 * @see upload_node_view()
 * @see comment_node_view()
563 564
 *
 * @param $node
565
 *   The node that is being assembled for rendering.
566 567
 * @param $view_mode
 *   The $view_mode parameter from node_view().
568
 */
569
function hook_node_view($node, $view_mode) {
570
  $node->content['my_additional_field'] = array(
571
    '#markup' => $additional_field,
572
    '#weight' => 10,
573
    '#theme' => 'mymodule_my_additional_field',
574
  );
575 576
}

577
/**
578
 * Alter the results of node_view().
579
 *
580 581 582
 * This hook is called after the content has been assembled in a structured
 * array and may be used for doing processing which requires that the complete
 * node content structure has been built.
583 584
 *
 * If the module wishes to act on the rendered HTML of the node rather than the
585 586
 * structured content array, it may use this hook to add a #post_render
 * callback.  Alternatively, it could also implement hook_preprocess_node(). See
587 588
 * drupal_render() and theme() documentation respectively for details.
 *
589 590 591
 * @param $build
 *   A renderable array representing the node content.
 *
592
 * @see node_view()
593
 */
594
function hook_node_view_alter($build) {
595
  if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
596
    // Change its weight.
597
    $build['an_additional_field']['#weight'] = -10;
598
  }
599 600

  // Add a #post_render callback to act on the rendered HTML of the node.
601
  $build['#post_render'][] = 'my_module_node_post_render';
602 603
}

604
/**
605
 * Define module-provided node types.
606
 *
607 608 609 610
 * This hook allows a module to define one or more of its own node types. For
 * example, the blog module uses it to define a blog node-type named "Blog
 * entry." The name and attributes of each desired node type are specified in
 * an array returned by the hook.
611
 *
612 613 614 615 616 617
 * Only module-provided node types should be defined through this hook. User-
 * provided (or 'custom') node types should be defined only in the 'node_type'
 * database table, and should be maintained by using the node_type_save() and
 * node_type_delete() functions.
 *
 * @return
618 619 620 621
 *   An array of information defining the module's node types. The array
 *   contains a sub-array for each node type, with the machine-readable type
 *   name as the key. Each sub-array has up to 10 attributes. Possible
 *   attributes:
622
 *   - "name": the human-readable name of the node type. Required.
623 624 625
 *   - "base": the base string used to construct callbacks corresponding to
 *      this node type.
 *      (i.e. if base is defined as example_foo, then example_foo_insert will
626
 *      be called when inserting a node of that type). This string is usually
627
 *      the name of the module, but not always. Required.
628
 *   - "description": a brief description of the node type. Required.
629 630
 *   - "help": help information shown to the user when creating a node of
 *      this type.. Optional (defaults to '').
631 632 633 634
 *   - "has_title": boolean indicating whether or not this node type has a title
 *      field. Optional (defaults to TRUE).
 *   - "title_label": the label for the title field of this content type.
 *      Optional (defaults to 'Title').
635
 *   - "has_body": boolean indicating whether or not this node type has a body
636 637 638
 *      field. Optional (defaults to TRUE).
 *   - "body_label": the label for the body field of this content type. Optional
 *      (defaults to 'Body').
639
 *   - "locked": boolean indicating whether the administrator can change the
640 641
 *      machine name of this type. FALSE = changeable (not locked),
 *      TRUE = unchangeable (locked). Optional (defaults to TRUE).
642 643 644
 *
 * The machine-readable name of a node type should contain only letters,
 * numbers, and underscores. Underscores will be converted into hyphens for the
645
 * purpose of constructing URLs.
646 647 648 649 650 651 652 653 654
 *
 * All attributes of a node type that are defined through this hook (except for
 * 'locked') can be edited by a site administrator. This includes the
 * machine-readable name of a node type, if 'locked' is set to FALSE.
 *
 * For a detailed usage example, see node_example.module.
 */
function hook_node_info() {
  return array(
655 656 657 658
    'blog' => array(
      'name' => t('Blog entry'),
      'base' => 'blog',
      'description' => t('Use for multi-user blogs. Every user gets a personal blog.'),
659 660 661 662
    )
  );
}

663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
/**
 * Provide additional methods of scoring for core search results for nodes.
 *
 * A node's search score is used to rank it among other nodes matched by the
 * search, with the highest-ranked nodes appearing first in the search listing.
 *
 * For example, a module allowing users to vote on content could expose an
 * option to allow search results' rankings to be influenced by the average
 * voting score of a node.
 *
 * All scoring mechanisms are provided as options to site administrators, and
 * may be tweaked based on individual sites or disabled altogether if they do
 * not make sense. Individual scoring mechanisms, if enabled, are assigned a
 * weight from 1 to 10. The weight represents the factor of magnification of
 * the ranking mechanism, with higher-weighted ranking mechanisms having more
 * influence. In order for the weight system to work, each scoring mechanism
 * must return a value between 0 and 1 for every node. That value is then
 * multiplied by the administrator-assigned weight for the ranking mechanism,
 * and then the weighted scores from all ranking mechanisms are added, which
 * brings about the same result as a weighted average.
 *
 * @return
 *   An associative array of ranking data. The keys should be strings,
 *   corresponding to the internal name of the ranking mechanism, such as
 *   'recent', or 'comments'. The values should be arrays themselves, with the
 *   following keys available:
 *   - "title": the human readable name of the ranking mechanism. Required.
 *   - "join": part of a query string to join to any additional necessary
 *     table. This is not necessary if the table required is already joined to
 *     by the base query, such as for the {node} table. Other tables should use
 *     the full table name as an alias to avoid naming collisions. Optional.
 *   - "score": part of a query string to calculate the score for the ranking
 *     mechanism based on values in the database. This does not need to be
 *     wrapped in parentheses, as it will be done automatically; it also does
 *     not need to take the weighted system into account, as it will be done
 *     automatically. It does, however, need to calculate a decimal between
 *     0 and 1; be careful not to cast the entire score to an integer by
700
 *     inadvertently introducing a variable argument. Required.
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
 *   - "arguments": if any arguments are required for the score, they can be
 *     specified in an array here.
 */
function hook_ranking() {
  // If voting is disabled, we can avoid returning the array, no hard feelings.
  if (variable_get('vote_node_enabled', TRUE)) {
    return array(
      'vote_average' => array(
        'title' => t('Average vote'),
        // Note that we use i.sid, the search index's search item id, rather than
        // n.nid.
        'join' => 'LEFT JOIN {vote_node_data} vote_node_data ON vote_node_data.nid = i.sid',
        // The highest possible score should be 1, and the lowest possible score,
        // always 0, should be 0.
        'score' => 'vote_node_data.average / CAST(%f AS DECIMAL)',
        // Pass in the highest possible voting score as a decimal argument.
        'arguments' => array(variable_get('vote_score_max', 5)),
      ),
    );
  }
}


724
/**
725
 * Respond to node type creation.
726
 *
727 728
 * This hook is invoked from node_type_save() after the node type is added
 * to the database.
729 730
 *
 * @param $info
731
 *   The node type object that is being created.
732 733 734 735
 */
function hook_node_type_insert($info) {
}

736
/**
737
 * Respond to node type updates.
738
 *
739 740
 * This hook is invoked from node_type_save() after the node type is updated
 * in the database.
741 742
 *
 * @param $info
743
 *   The node type object that is being updated.
744
 */
745 746 747 748 749
function hook_node_type_update($info) {
  if (!empty($info->old_type) && $info->old_type != $info->type) {
    $setting = variable_get('comment_' . $info->old_type, COMMENT_NODE_OPEN);
    variable_del('comment_' . $info->old_type);
    variable_set('comment_' . $info->type, $setting);
750 751 752
  }
}

753
/**
754
 * Respond to node type deletion.
755
 *
756 757
 * This hook is invoked from node_type_delete() after the node type is removed
 * from the database.
758 759
 *
 * @param $info
760
 *   The node type object that is being deleted.
761 762 763 764 765
 */
function hook_node_type_delete($info) {
  variable_del('comment_' . $info->type);
}

766 767 768
/**
 * Respond to node deletion.
 *
769 770
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_delete() to respond to all node deletions).
771
 *
772 773 774
 * This hook is invoked from node_delete_multiple() after the node has been
 * removed from the node table in the database, before hook_node_delete() is
 * invoked, and before field_attach_delete() is called.
775
 *
776 777
 * @param $node
 *   The node that is being deleted.
778
 */
779
function hook_delete($node) {
780 781 782
  db_delete('mytable')
    ->condition('nid', $nid->nid)
    ->execute();
783 784 785
}

/**
786
 * Act on a node object about to be shown on the add/edit form.
787
 *
788 789
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_prepare() to act on all node preparations).
790
 *
791 792 793 794 795
 * This hook is invoked from node_object_prepare() before the general
 * hook_node_prepare() is invoked.
 *
 * @param $node
 *   The node that is about to be shown on the add/edit form.
796
 */
797
function hook_prepare($node) {
798 799 800
  if ($file = file_check_upload($field_name)) {
    $file = file_save_upload($field_name, _image_filename($file->filename, NULL, TRUE));
    if ($file) {
801
      if (!image_get_info($file->uri)) {
802 803 804 805 806 807 808
        form_set_error($field_name, t('Uploaded file is not a valid image'));
        return;
      }
    }
    else {
      return;
    }
809
    $node->images['_original'] = $file->uri;
810
    _image_build_derivatives($node, TRUE);
811 812 813 814 815 816 817 818 819 820 821
    $node->new_file = TRUE;
  }
}

/**
 * Display a node editing form.
 *
 * This hook, implemented by node modules, is called to retrieve the form
 * that is displayed when one attempts to "create/edit" an item. This form is
 * displayed at the URI http://www.example.com/?q=node/<add|edit>/nodetype.
 *
822
 * @param $node
823 824 825 826 827 828 829 830 831 832 833 834 835 836
 *   The node being added or edited.
 * @param $form_state
 *   The form state array. Changes made to this variable will have no effect.
 * @return
 *   An array containing the form elements to be displayed in the node
 *   edit form.
 *
 * The submit and preview buttons, taxonomy controls, and administrative
 * accoutrements are displayed automatically by node.module. This hook
 * needs to return the node title, the body text area, and fields
 * specific to the node type.
 *
 * For a detailed usage example, see node_example.module.
 */
837
function hook_form($node, $form_state) {
838
  $type = node_type_get_type($node);
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865

  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => check_plain($type->title_label),
    '#required' => TRUE,
  );
  $form['body'] = array(
    '#type' => 'textarea',
    '#title' => check_plain($type->body_label),
    '#rows' => 20,
    '#required' => TRUE,
  );
  $form['field1'] = array(
    '#type' => 'textfield',
    '#title' => t('Custom field'),
    '#default_value' => $node->field1,
    '#maxlength' => 127,
  );
  $form['selectbox'] = array(
    '#type' => 'select',
    '#title' => t('Select box'),
    '#default_value' => $node->selectbox,
    '#options' => array(
      1 => 'Option A',
      2 => 'Option B',
      3 => 'Option C',
    ),
866
    '#description' => t('Choose an option.'),
867 868 869 870 871 872
  );

  return $form;
}

/**
873
 * Respond to creation of a new node.
874
 *
875 876
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_insert() to act on all node insertions).
877
 *
878 879 880
 * This hook is invoked from node_save() after the node is inserted into the
 * node table in the database, before field_attach_insert() is called, and
 * before hook_node_insert() is invoked.
881
 *
882 883
 * @param $node
 *   The node that is being created.
884
 */
885
function hook_insert($node) {
886 887 888 889 890 891
  db_insert('mytable')
    ->fields(array(
      'nid' => $node->nid,
      'extra' => $node->extra,
    ))
    ->execute();
892 893 894
}

/**
895
 * Act on nodes being loaded from the database.
896
 *
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_load() to respond to all node loads).
 *
 * This hook is invoked during node loading, which is handled by entity_load(),
 * via classes NodeController and DrupalDefaultEntityController. After the node
 * information is read from the database or the entity cache, hook_load() is
 * invoked on the node's content type module, then field_attach_node_revision()
 * or field_attach_load() is called, then hook_entity_load() is invoked on all
 * implementing modules, and finally hook_node_load() is invoked on all
 * implementing modules.
 *
 * This hook should only be used to add information that is not in the node or
 * node revisions table, not to replace information that is in these tables
 * (which could interfere with the entity cache). For performance reasons,
 * information for all available nodes should be loaded in a single query where
 * possible.
913
 *
914
 * @param $nodes
915
 *   An array of the nodes being loaded, keyed by nid.
916 917 918
 *
 * For a detailed usage example, see node_example.module.
 */
919
function hook_load($nodes) {
920
  $result = db_query('SELECT nid, foo FROM {mytable} WHERE nid IN (:nids)', array(':nids' => array_keys($nodes)));
921 922 923
  foreach ($result as $record) {
    $nodes[$record->nid]->foo = $record->foo;
  }
924 925 926
}

/**
927
 * Respond to updates to a node.
928
 *
929 930
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_update() to act on all node updates).
931
 *
932 933 934
 * This hook is invoked from node_save() after the node is updated in the
 * node table in the database, before field_attach_update() is called, and
 * before hook_node_update() is invoked.
935
 *
936 937
 * @param $node
 *   The node that is being updated.
938
 */
939
function hook_update($node) {
940 941 942 943
  db_update('mytable')
    ->fields(array('extra' => $node->extra))
    ->condition('nid', $node->nid)
    ->execute();
944 945 946
}

/**
947
 * Perform node validation before a node is created or updated.
948
 *
949 950
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_validate() to act on all node validations).
951
 *
952 953 954 955
 * This hook is invoked from node_validate(), after a user has has finished
 * editing the node and is previewing or submitting it. It is invoked at the end
 * of all the standard validation steps, and before hook_node_validate() is
 * invoked.
956
 *
957
 * To indicate a validation error, use form_set_error().
958
 *
959 960
 * Note: Changes made to the $node object within your hook implementation will
 * have no effect.  The preferred method to change a node's content is to use
961
 * hook_node_presave() instead. If it is really necessary to change
962
 * the node at the validate stage, you can use form_set_value().
963
 *
964 965 966 967
 * @param $node
 *   The node being validated.
 * @param $form
 *   The form being used to edit the node.
968
 */
969
function hook_validate($node, &$form) {
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
  if (isset($node->end) && isset($node->start)) {
    if ($node->start > $node->end) {
      form_set_error('time', t('An event may not end before it starts.'));
    }
  }
}

/**
 * Display a node.
 *
 * This is a hook used by node modules. It allows a module to define a
 * custom method of displaying its nodes, usually by displaying extra
 * information particular to that node type.
 *
 * @param $node
985
 *   The node to be displayed, as returned by node_load().
986 987
 * @param $view_mode
 *   View mode, e.g. 'full', 'teaser', ...
988 989 990
 * @return
 *   $node. The passed $node parameter should be modified as necessary and
 *   returned so it can be properly presented. Nodes are prepared for display
991 992
 *   by assembling a structured array, formatted as in the Form API, in
 *   $node->content. As with Form API arrays, the #weight property can be
993
 *   used to control the relative positions of added elements. After this
994
 *   hook is invoked, node_view() calls field_attach_view() to add field
995
 *   views to $node->content, and then invokes hook_node_view() and
996
 *   hook_node_view_alter(), so if you want to affect the final
997 998
 *   view of the node, you might consider implementing one of these hooks
 *   instead.
999 1000 1001
 *
 * For a detailed usage example, see node_example.module.
 */
1002
function hook_view($node, $view_mode = 'full') {
1003
  if (node_is_page($node)) {
1004
    $breadcrumb = array();
1005 1006 1007 1008
    $breadcrumb[] = l(t('Home'), NULL);
    $breadcrumb[] = l(t('Example'), 'example');
    $breadcrumb[] = l($node->field1, 'example/' . $node->field1);
    drupal_set_breadcrumb($breadcrumb);
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
  }

  $node->content['myfield'] = array(
    '#value' => theme('mymodule_myfield', $node->myfield),
    '#weight' => 1,
  );

  return $node;
}

/**
 * @} End of "addtogroup hooks".
 */