node.api.php 36.7 KB
Newer Older
1 2
<?php

3
use Drupal\Core\Entity\EntityInterface;
4

5 6 7 8 9
/**
 * @file
 * Hooks provided by the Node module.
 */

10 11 12
/**
 * @defgroup node_api_hooks Node API Hooks
 * @{
13
 * Functions to define and modify content types.
14 15
 *
 * Each content type is maintained by a primary module, which is either
16
 * node.module (for content types created in the user interface) or the module
17
 * that defines the content type by providing configuration file.
18
 *
19 20 21
 * During node operations (create, insert, update, view, delete, etc.), there
 * are several sets of hooks that get invoked to allow modules to modify the
 * base node operation:
22 23
 * - All-module hooks: This set of hooks is invoked on all implementing modules,
 *   to allow other modules to modify what the primary node module is doing. For
24
 *   example, hook_node_insert() is invoked on all modules when creating a forum
25
 *   node.
26 27 28 29 30 31 32 33
 * - Field hooks: Hooks related to the fields attached to the node. These are
 *   invoked from the field operations functions described below, and can be
 *   either field-type-specific or all-module hooks.
 * - Entity hooks: Generic hooks for "entity" operations. These are always
 *   invoked on all modules.
 *
 * Here is a list of the node and entity hooks that are invoked, field
 * operations, and other steps that take place during node operations:
34 35 36
 * - Instantiating a new node:
 *   - hook_node_create() (all)
 *   - hook_entity_create() (all)
37
 * - Creating a new node (calling $node->save() on a new node):
38 39
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
40
 *   - hook_entity_presave() (all)
41 42 43 44 45 46
 *   - Node and revision records are written to the database
 *   - field_attach_insert()
 *   - hook_node_insert() (all)
 *   - hook_entity_insert() (all)
 *   - hook_node_access_records() (all)
 *   - hook_node_access_records_alter() (all)
47
 * - Updating an existing node (calling $node->save() on an existing node):
48 49
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
50
 *   - hook_entity_presave() (all)
51 52 53 54 55 56
 *   - Node and revision records are written to the database
 *   - field_attach_update()
 *   - hook_node_update() (all)
 *   - hook_entity_update() (all)
 *   - hook_node_access_records() (all)
 *   - hook_node_access_records_alter() (all)
57
 * - Loading a node (calling node_load(), node_load_multiple(), entity_load(),
58
 *   or entity_load_multiple() with $entity_type of 'node'):
59 60 61 62 63
 *   - Node and revision information is read from database.
 *   - field_attach_load_revision() and field_attach_load()
 *   - hook_entity_load() (all)
 *   - hook_node_load() (all)
 * - Viewing a single node (calling node_view() - note that the input to
64
 *   node_view() is a loaded node, so the Loading steps above are already done):
65
 *   - field_attach_prepare_view()
66
 *   - hook_entity_prepare_view() (all)
67 68
 *   - field_attach_view()
 *   - hook_node_view() (all)
69 70 71
 *   - hook_entity_view() (all)
 *   - hook_node_view_alter() (all)
 *   - hook_entity_view_alter() (all)
72 73 74 75
 * - Viewing multiple nodes (calling node_view_multiple() - note that the input
 *   to node_view_multiple() is a set of loaded nodes, so the Loading steps
 *   above are already done):
 *   - field_attach_prepare_view()
76
 *   - hook_entity_prepare_view() (all)
77 78
 *   - field_attach_view()
 *   - hook_node_view() (all)
79
 *   - hook_entity_view() (all)
80
 *   - hook_node_view_alter() (all)
81
 *   - hook_entity_view_alter() (all)
82
 * - Deleting a node (calling $node->delete() or entity_delete_multiple()):
83
 *   - Node is loaded (see Loading section above)
84 85
 *   - hook_node_predelete() (all)
 *   - hook_entity_predelete() (all)
86
 *   - field_attach_delete()
87
 *   - Node and revision information are deleted from database
88 89
 *   - hook_node_delete() (all)
 *   - hook_entity_delete() (all)
90 91 92 93 94
 * - Deleting a node revision (calling node_revision_delete()):
 *   - Node is loaded (see Loading section above)
 *   - Revision information is deleted from database
 *   - hook_node_revision_delete() (all)
 *   - field_attach_delete_revision()
95 96
 * - Preparing a node for editing (calling node_form() - note that if it is an
 *   existing node, it will already be loaded; see the Loading section above):
97 98
 *   - hook_node_prepare_form() (all)
 *   - hook_entity_prepare_form() (all)
99 100 101 102 103 104 105 106 107
 *   - field_attach_form()
 * - Validating a node during editing form submit (calling
 *   node_form_validate()):
 *   - hook_node_validate() (all)
 * - Searching (calling node_search_execute()):
 *   - hook_ranking() (all)
 *   - Query is executed to find matching nodes
 *   - Resulting node is loaded (see Loading section above)
 *   - Resulting node is prepared for viewing (see Viewing a single node above)
108
 *   - comment_node_update_index() is called.
109 110 111 112 113 114 115 116
 *   - hook_node_search_result() (all)
 * - Search indexing (calling node_update_index()):
 *   - Node is loaded (see Loading section above)
 *   - Node is prepared for viewing (see Viewing a single node above)
 *   - hook_node_update_index() (all)
 * @}
 */

117 118 119 120 121 122 123 124
/**
 * @addtogroup hooks
 * @{
 */

/**
 * Inform the node access system what permissions the user has.
 *
125 126 127 128
 * 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.
129
 *
130
 * The realms and grant IDs can be arbitrarily defined by your node access
131 132 133 134
 * 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.
135
 *
136 137 138 139 140
 * A node access module may implement as many realms as necessary to properly
 * define the access privileges for the nodes. Note that the system makes no
 * distinction between published and unpublished nodes. It is the module's
 * responsibility to provide appropriate realms to limit access to unpublished
 * content.
141
 *
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
 * Node access records are stored in the {node_access} table and define which
 * grants are required to access a node. There is a special case for the view
 * operation -- a record with node ID 0 corresponds to a "view all" grant for
 * the realm and grant ID of that record. If there are no node access modules
 * enabled, the core node module adds a node ID 0 record for realm 'all'. Node
 * access modules can also grant "view all" permission on their custom realms;
 * for example, a module could create a record in {node_access} with:
 * @code
 * $record = array(
 *   'nid' => 0,
 *   'gid' => 888,
 *   'realm' => 'example_realm',
 *   'grant_view' => 1,
 *   'grant_update' => 0,
 *   'grant_delete' => 0,
 * );
 * drupal_write_record('node_access', $record);
 * @endcode
 * And then in its hook_node_grants() implementation, it would need to return:
 * @code
 * if ($op == 'view') {
 *   $grants['example_realm'] = array(888);
 * }
 * @endcode
 * If you decide to do this, be aware that the node_access_rebuild() function
 * will erase any node ID 0 entry when it is called, so you will need to make
 * sure to restore your {node_access} record after node_access_rebuild() is
 * called.
 *
171
 * @param $account
172 173
 *   The user object whose grants are requested.
 * @param $op
174
 *   The node operation to be performed, such as 'view', 'update', or 'delete'.
175
 *
176
 * @return
177 178
 *   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.
179 180 181
 *
 * For a detailed example, see node_access_example.module.
 *
182 183
 * @see node_access_view_all_nodes()
 * @see node_access_rebuild()
184 185 186 187 188 189
 * @ingroup node_access
 */
function hook_node_grants($account, $op) {
  if (user_access('access private content', $account)) {
    $grants['example'] = array(1);
  }
190
  $grants['example_owner'] = array($account->id());
191 192 193 194 195 196
  return $grants;
}

/**
 * Set permissions for a node to be written to the database.
 *
197 198 199
 * 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
200 201
 * node.
 *
202 203 204 205 206 207
 * Node access grants apply regardless of the published or unpublished status
 * of the node. Implementations must make sure not to grant access to
 * unpublished nodes if they don't want to change the standard access control
 * behavior. Your module may need to create a separate access realm to handle
 * access to unpublished nodes.
 *
208 209 210
 * Note that the grant values in the return value from your hook must be
 * integers and not boolean TRUE and FALSE.
 *
211 212 213 214
 * 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().
215
 * - 'grant_view': If set to 1 a user that has been identified as a member
216 217 218
 *   of this gid within this realm can view this node. This should usually be
 *   set to $node->status. Failure to do so may expose unpublished content
 *   to some users.
219
 * - 'grant_update': If set to 1 a user that has been identified as a member
220
 *   of this gid within this realm can edit this node.
221
 * - 'grant_delete': If set to 1 a user that has been identified as a member
222
 *   of this gid within this realm can delete this node.
223 224 225 226 227 228 229 230
 * - langcode: (optional) The language code of a specific translation of the
 *   node, if any. Modules may add this key to grant different access to
 *   different translations of a node, such that (e.g.) a particular group is
 *   granted access to edit the Catalan version of the node, but not the
 *   Hungarian version. If no value is provided, the langcode is set
 *   automatically from the $node parameter and the node's original language (if
 *   specified) is used as a fallback. Only specify multiple grant records with
 *   different languages for a node if the site has those languages configured.
231
 *
232 233
 * A "deny all" grant may be used to deny all access to a particular node or
 * node translation:
234 235 236 237 238 239 240
 * @code
 * $grants[] = array(
 *   'realm' => 'all',
 *   'gid' => 0,
 *   'grant_view' => 0,
 *   'grant_update' => 0,
 *   'grant_delete' => 0,
241
 *   'langcode' => 'ca',
242 243
 * );
 * @endcode
244 245 246 247 248
 * Note that another module node access module could override this by granting
 * access to one or more nodes, since grants are additive. To enforce that
 * access is denied in a particular case, use hook_node_access_records_alter().
 * Also note that a deny all is not written to the database; denies are
 * implicit.
249
 *
250
 * @param \Drupal\Core\Entity\EntityInterface $node
251 252 253 254 255
 *   The node that has just been saved.
 *
 * @return
 *   An array of grants as defined above.
 *
256
 * @see node_access_write_grants()
257
 * @see hook_node_access_records_alter()
258 259
 * @ingroup node_access
 */
260
function hook_node_access_records(\Drupal\Core\Entity\EntityInterface $node) {
261
  // We only care about the node if it has been marked private. If not, it is
262 263 264
  // treated just like any other node and we completely ignore it.
  if ($node->private) {
    $grants = array();
265 266 267
    // Only published Catalan translations of private nodes should be viewable
    // to all users. If we fail to check $node->status, all users would be able
    // to view an unpublished node.
268 269 270 271 272 273 274
    if ($node->status) {
      $grants[] = array(
        'realm' => 'example',
        'gid' => 1,
        'grant_view' => 1,
        'grant_update' => 0,
        'grant_delete' => 0,
275
        'langcode' => 'ca'
276 277
      );
    }
278
    // For the example_author array, the GID is equivalent to a UID, which
279 280 281
    // means there are many groups of just 1 user.
    // Note that an author can always view his or her nodes, even if they
    // have status unpublished.
282 283 284
    $grants[] = array(
      'realm' => 'example_author',
      'gid' => $node->uid,
285 286 287
      'grant_view' => 1,
      'grant_update' => 1,
      'grant_delete' => 1,
288
      'langcode' => 'ca'
289
    );
290

291 292 293 294
    return $grants;
  }
}

295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
/**
 * 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.
 *
 * 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.
 *
310 311
 * A module may deny all access to a node by setting $grants to an empty array.
 *
312
 * @param $grants
313
 *   The $grants array returned by hook_node_access_records().
314
 * @param \Drupal\Core\Entity\EntityInterface $node
315 316 317
 *   The node for which the grants were acquired.
 *
 * The preferred use of this hook is in a module that bridges multiple node
318 319
 * access modules with a configurable behavior, as shown in the example with the
 * 'is_preview' field.
320
 *
321 322 323
 * @see hook_node_access_records()
 * @see hook_node_grants()
 * @see hook_node_grants_alter()
324 325
 * @ingroup node_access
 */
326
function hook_node_access_records_alter(&$grants, Drupal\Core\Entity\EntityInterface $node) {
327 328 329 330 331 332 333 334 335
  // 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);
336 337 338 339 340 341 342
  }
}

/**
 * Alter user access rules when trying to view, edit or delete a node.
 *
 * Node access modules establish rules for user access to content.
343 344 345 346 347
 * 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.
348 349 350 351
 *
 * The resulting grants are then checked against the records stored in the
 * {node_access} table to determine if the operation may be completed.
 *
352 353
 * A module may deny all access to a user by setting $grants to an empty array.
 *
354 355
 * 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
356 357
 * permissions assigned to a user role, or specific attributes of a user
 * account.
358
 *
359
 * @param $grants
360 361 362 363 364 365
 *   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'.
 *
366 367 368
 * @see hook_node_grants()
 * @see hook_node_access_records()
 * @see hook_node_access_records_alter()
369 370 371 372 373 374 375 376 377 378
 * @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());
379

380 381
  if ($op != 'view' && !empty($restricted)) {
    // Now check the roles for this account against the restrictions.
382
    foreach ($account->getRoles() as $rid) {
383
      if (in_array($rid, $restricted)) {
384 385 386 387 388 389
        $grants = array();
      }
    }
  }
}

390
/**
391
 * Act before node deletion.
392
 *
393 394 395
 * This hook is invoked from entity_delete_multiple() before
 * hook_entity_predelete() and field_attach_delete() are called, and before
 * the node is removed from the node table in the database.
396
 *
397
 * @param \Drupal\Core\Entity\EntityInterface $node
398
 *   The node that is about to be deleted.
399
 *
400
 * @see hook_node_predelete()
401
 * @see entity_delete_multiple()
402
 * @ingroup node_api_hooks
403
 */
404
function hook_node_predelete(\Drupal\Core\Entity\EntityInterface $node) {
405
  db_delete('mytable')
406
    ->condition('nid', $node->id())
407
    ->execute();
408 409
}

410 411 412
/**
 * Respond to node deletion.
 *
413
 * This hook is invoked from entity_delete_multiple() after field_attach_delete()
414 415
 * has been called and after the node has been removed from the database.
 *
416
 * @param \Drupal\Core\Entity\EntityInterface $node
417 418 419
 *   The node that has been deleted.
 *
 * @see hook_node_predelete()
420
 * @see entity_delete_multiple()
421 422
 * @ingroup node_api_hooks
 */
423
function hook_node_delete(\Drupal\Core\Entity\EntityInterface $node) {
424
  drupal_set_message(t('Node: @title has been deleted', array('@title' => $node->label())));
425 426
}

427
/**
428
 * Respond to deletion of a node revision.
429
 *
430 431 432
 * 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.
433
 *
434
 * @param \Drupal\Core\Entity\EntityInterface $node
435
 *   The node revision (node object) that is being deleted.
436 437
 *
 * @ingroup node_api_hooks
438
 */
439
function hook_node_revision_delete(\Drupal\Core\Entity\EntityInterface $node) {
440 441 442
  db_delete('mytable')
    ->condition('vid', $node->vid)
    ->execute();
443 444 445
}

/**
446
 * Respond to creation of a new node.
447
 *
448
 * This hook is invoked from $node->save() after the database query that will
449 450
 * insert the node into the node table is scheduled for execution, and after
 * field_attach_insert() is called.
451 452 453 454
 *
 * Note that when this hook is invoked, the changes have not yet been written to
 * the database, because a database transaction is still in progress. The
 * transaction is not finalized until the save operation is entirely completed
455
 * and $node->save() goes out of scope. You should not rely on data in the
456 457
 * database at this time as it is not updated yet. You should also note that any
 * write/update database queries executed from this hook are also not committed
458
 * immediately. Check $node->save() and db_transaction() for more info.
459
 *
460
 * @param \Drupal\Core\Entity\EntityInterface $node
461
 *   The node that is being created.
462 463
 *
 * @ingroup node_api_hooks
464
 */
465
function hook_node_insert(\Drupal\Core\Entity\EntityInterface $node) {
466 467
  db_insert('mytable')
    ->fields(array(
468
      'nid' => $node->id(),
469 470 471
      'extra' => $node->extra,
    ))
    ->execute();
472 473
}

474 475 476 477 478 479
/**
 * Act on a newly created node.
 *
 * This hook runs after a new node object has just been instantiated. It can be
 * used to set initial values, e.g. to provide defaults.
 *
480
 * @param \Drupal\Core\Entity\EntityInterface $node
481 482 483 484
 *   The node object.
 *
 * @ingroup node_api_hooks
 */
485
function hook_node_create(\Drupal\Core\Entity\EntityInterface $node) {
486 487 488 489 490
  if (!isset($node->foo)) {
    $node->foo = 'some_initial_value';
  }
}

491
/**
492 493
 * Act on arbitrary nodes being loaded from the database.
 *
494 495 496 497
 * This hook should 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.
498 499
 *
 * This hook is invoked during node loading, which is handled by entity_load(),
500 501
 * via classes Drupal\node\NodeStorageController and
 * Drupal\Core\Entity\DatabaseStorageController. After the node information is
502 503
 * read from the database or the entity cache, then field_attach_load_revision()
 * or field_attach_load() is called, then hook_entity_load() is invoked on all
504 505
 * implementing modules, and finally hook_node_load() is invoked on all
 * implementing modules.
506
 *
507
 * @param $nodes
508
 *   An array of the nodes being loaded, keyed by nid.
509
 * @param $types
510
 *   An array containing the node types present in $nodes. Allows for an early
511
 *   return for modules that only support certain node types.
512 513
 *
 * For a detailed usage example, see nodeapi_example.module.
514 515
 *
 * @ingroup node_api_hooks
516
 */
517
function hook_node_load($nodes, $types) {
518 519 520 521 522 523 524 525
  // Decide whether any of $types are relevant to our purposes.
  if (count(array_intersect($types_we_want_to_process, $types))) {
    // Gather our extra data for each of these nodes.
    $result = db_query('SELECT nid, foo FROM {mytable} WHERE nid IN(:nids)', array(':nids' => array_keys($nodes)));
    // Add our extra data to the node objects.
    foreach ($result as $record) {
      $nodes[$record->nid]->foo = $record->foo;
    }
526 527 528
  }
}

529
/**
530
 * Controls access to a node.
531 532 533 534
 *
 * 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.
 *
535 536
 * 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"
537 538 539
 * permission may always view and edit content through the administrative
 * interface.
 *
540 541 542 543
 * 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.
544
 *
545 546 547 548
 * Also note that this function isn't called for node listings (e.g., RSS feeds,
 * the default home page at path 'node', a recent content block, etc.) See
 * @link node_access Node access rights @endlink for a full explanation.
 *
549
 * @param Drupal\Core\Entity\EntityInterface|string $node
550
 *   Either a node entity or the machine name of the content type on which to
551
 *   perform the access check.
552
 * @param string $op
553 554 555 556 557
 *   The operation to be performed. Possible values:
 *   - "create"
 *   - "delete"
 *   - "update"
 *   - "view"
558
 * @param object $account
559
 *   The user object to perform the access check operation on.
560 561
 * @param object $langcode
 *   The language code to perform the access check operation on.
562
 *
563
 * @return string
564 565 566
 *   - NODE_ACCESS_ALLOW: if the operation is to be allowed.
 *   - NODE_ACCESS_DENY: if the operation is to be denied.
 *   - NODE_ACCESS_IGNORE: to not affect this operation at all.
567 568
 *
 * @ingroup node_access
569
 */
570
function hook_node_access($node, $op, $account, $langcode) {
571
  $type = is_string($node) ? $node : $node->type;
572

573 574
  $configured_types = node_permissions_get_configured_types();
  if (isset($configured_types[$type])) {
575 576 577 578 579
    if ($op == 'create' && user_access('create ' . $type . ' content', $account)) {
      return NODE_ACCESS_ALLOW;
    }

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

    if ($op == 'delete') {
586
      if (user_access('delete any ' . $type . ' content', $account) || (user_access('delete own ' . $type . ' content', $account) && ($account->id() == $node->uid))) {
587 588 589 590 591 592 593 594 595 596
        return NODE_ACCESS_ALLOW;
      }
    }
  }

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


597
/**
598 599
 * Act on a node object about to be shown on the add/edit form.
 *
600
 * This hook is invoked from NodeFormController::prepareEntity().
601
 *
602 603 604 605 606 607 608 609
 * @param \Drupal\node\NodeInterface $node
 *   The node that is about to be shown on the form.
 * @param $form_display
 *   The current form display.
 * @param $operation
 *   The current operation.
 * @param array $form_state
 *   An associative array containing the current state of the form.
610 611
 *
 * @ingroup node_api_hooks
612
 */
613
function hook_node_prepare_form(\Drupal\node\NodeInterface $node, $form_display, $operation, array &$form_state) {
614
  if (!isset($node->comment)) {
615
    $node->comment = variable_get("comment_$node->type", COMMENT_NODE_OPEN);
616 617 618 619
  }
}

/**
620
 * Act on a node being displayed as a search result.
621
 *
622 623
 * This hook is invoked from node_search_execute(), after node_load() and
 * node_view() have been called.
624
 *
625
 * @param \Drupal\Core\Entity\EntityInterface $node
626
 *   The node being displayed in a search result.
627 628
 * @param $langcode
 *   Language code of result being displayed.
629
 *
630 631
 * @return array
 *   Extra information to be displayed with search result. This information
632 633 634
 *   should be presented as an associative array. It will be concatenated with
 *   the post information (last updated, author) in the default search result
 *   theming.
635 636 637
 *
 * @see template_preprocess_search_result()
 * @see search-result.tpl.php
638 639
 *
 * @ingroup node_api_hooks
640
 */
641
function hook_node_search_result(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
642
  $comments = db_query('SELECT comment_count FROM {node_comment_statistics} WHERE nid = :nid', array('nid' => $node->id()))->fetchField();
643
  return array('comment' => format_plural($comments, '1 comment', '@count comments'));
644 645 646
}

/**
647
 * Act on a node being inserted or updated.
648
 *
649
 * This hook is invoked from $node->save() before the node is saved to the
650
 * database.
651
 *
652
 * @param \Drupal\Core\Entity\EntityInterface $node
653
 *   The node that is being inserted or updated.
654 655
 *
 * @ingroup node_api_hooks
656
 */
657
function hook_node_presave(\Drupal\Core\Entity\EntityInterface $node) {
658
  if ($node->id() && $node->moderate) {
659 660 661 662 663 664 665 666
    // Reset votes when node is updated:
    $node->score = 0;
    $node->users = '';
    $node->votes = 0;
  }
}

/**
667 668
 * Respond to updates to a node.
 *
669
 * This hook is invoked from $node->save() after the database query that will
670 671
 * update node in the node table is scheduled for execution, and after
 * field_attach_update() is called.
672 673 674 675
 *
 * Note that when this hook is invoked, the changes have not yet been written to
 * the database, because a database transaction is still in progress. The
 * transaction is not finalized until the save operation is entirely completed
676
 * and $node->save() goes out of scope. You should not rely on data in the
677 678
 * database at this time as it is not updated yet. You should also note that any
 * write/update database queries executed from this hook are also not committed
679
 * immediately. Check $node->save() and db_transaction() for more info.
680
 *
681
 * @param \Drupal\Core\Entity\EntityInterface $node
682
 *   The node that is being updated.
683 684
 *
 * @ingroup node_api_hooks
685
 */
686
function hook_node_update(\Drupal\Core\Entity\EntityInterface $node) {
687 688
  db_update('mytable')
    ->fields(array('extra' => $node->extra))
689
    ->condition('nid', $node->id())
690
    ->execute();
691 692 693
}

/**
694
 * Act on a node being indexed for searching.
695
 *
696 697
 * This hook is invoked during search indexing, after node_load(), and after the
 * result of node_view() is added as $node->rendered to the node object.
698
 *
699
 * @param \Drupal\Core\Entity\EntityInterface $node
700
 *   The node being indexed.
701 702
 * @param $langcode
 *   Language code of the variant of the node being indexed.
703
 *
704 705
 * @return string
 *   Additional node information to be indexed.
706 707
 *
 * @ingroup node_api_hooks
708
 */
709
function hook_node_update_index(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
710
  $text = '';
711
  $comments = db_query('SELECT subject, comment, format FROM {comment} WHERE nid = :nid AND status = :status', array(':nid' => $node->id(), ':status' => COMMENT_PUBLISHED));
712
  foreach ($comments as $comment) {
713
    $text .= '<h2>' . check_plain($comment->subject->value) . '</h2>' . $comment->comment_body->processed;
714 715 716 717 718
  }
  return $text;
}

/**
719 720
 * Perform node validation before a node is created or updated.
 *
721
 * This hook is invoked from NodeFormController::validate(), after a user has
722
 * finished editing the node and is previewing or submitting it. It is invoked
723
 * at the end of all the standard validation steps.
724
 *
725 726 727 728
 * 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
729 730
 * hook_node_presave() instead. If it is really necessary to change the node at
 * the validate stage, you can use form_set_value().
731
 *
732
 * @param \Drupal\Core\Entity\EntityInterface $node
733
 *   The node being validated.
734
 * @param $form
735
 *   The form being used to edit the node.
736 737
 * @param $form_state
 *   The form state array.
738 739
 *
 * @ingroup node_api_hooks
740
 */
741
function hook_node_validate(\Drupal\Core\Entity\EntityInterface $node, $form, &$form_state) {
742 743 744 745 746 747 748
  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.'));
    }
  }
}

749 750 751 752 753 754 755 756
/**
 * Act on a node after validated form values have been copied to it.
 *
 * This hook is invoked when a node form is submitted with either the "Save" or
 * "Preview" button, after form values have been copied to the form state's node
 * object, but before the node is saved or previewed. It is a chance for modules
 * to adjust the node's properties from what they are simply after a copy from
 * $form_state['values']. This hook is intended for adjusting non-field-related
757 758
 * properties. See hook_field_attach_extract_form_values() for customizing
 * field-related properties.
759
 *
760
 * @param \Drupal\Core\Entity\EntityInterface $node
761
 *   The node entity being updated in response to a form submission.
762 763 764 765 766 767 768
 * @param $form
 *   The form being used to edit the node.
 * @param $form_state
 *   The form state array.
 *
 * @ingroup node_api_hooks
 */
769
function hook_node_submit(\Drupal\Core\Entity\EntityInterface $node, $form, &$form_state) {
770 771 772 773 774 775 776
  // Decompose the selected menu parent option into 'menu_name' and 'plid', if
  // the form used the default parent selection widget.
  if (!empty($form_state['values']['menu']['parent'])) {
    list($node->menu['menu_name'], $node->menu['plid']) = explode(':', $form_state['values']['menu']['parent']);
  }
}

777
/**
778
 * Act on a node that is being assembled before rendering.
779
 *
780 781 782
 * The module may add elements to $node->content prior to rendering.
 * The structure of $node->content is a renderable array as expected by
 * drupal_render().
783
 *
784
 * When $view_mode is 'rss', modules can also add extra RSS elements and
785 786
 * namespaces to $node->rss_elements and $node->rss_namespaces respectively for
 * the RSS item generated for this node.
787
 * For details on how this is used, see node_feed().
788
 *
789
 * @param \Drupal\Core\Entity\EntityInterface $node
790
 *   The node that is being assembled for rendering.
791 792 793 794
 * @param \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display
 *   The entity_display object holding the display options configured for the
 *   node components.
 * @param string $view_mode
795
 *   The $view_mode parameter from node_view().
796
 * @param string $langcode
797
 *   The language code used for rendering.
798
 *
799 800
 * @see forum_node_view()
 * @see comment_node_view()
801 802
 * @see hook_entity_view()
 *
803
 * @ingroup node_api_hooks
804
 */
805
function hook_node_view(\Drupal\Core\Entity\EntityInterface $node, \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display, $view_mode, $langcode) {
806 807 808 809 810 811 812 813 814
  // Only do the extra work if the component is configured to be displayed.
  // This assumes a 'mymodule_addition' extra field has been defined for the
  // node type in hook_field_extra_fields().
  if ($display->getComponent('mymodule_addition')) {
    $node->content['mymodule_addition'] = array(
      '#markup' => mymodule_addition($node),
      '#theme' => 'mymodule_my_additional_field',
    );
  }
815 816
}

817
/**
818
 * Alter the results of node_view().
819
 *
820 821 822
 * 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.
823 824
 *
 * If the module wishes to act on the rendered HTML of the node rather than the
825
 * structured content array, it may use this hook to add a #post_render
826
 * callback.  Alternatively, it could also implement hook_preprocess_HOOK() for
827 828
 * node.html.twig. See drupal_render() and theme() documentation respectively
 * for details.
829
 *
830 831
 * @param $build
 *   A renderable array representing the node content.
832
 * @param \Drupal\Core\Entity\EntityInterface $node
833
 *   The node being rendered.
834 835 836
 * @param \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display
 *   The entity_display object holding the display options configured for the
 *   node components.
837
 *
838
 * @see node_view()
839
 * @see hook_entity_view_alter()
840 841
 *
 * @ingroup node_api_hooks
842
 */
843
function hook_node_view_alter(&$build, \Drupal\Core\Entity\EntityInterface $node, \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display) {
844
  if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
845
    // Change its weight.
846
    $build['an_additional_field']['#weight'] = -10;
847
  }
848 849

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

853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
/**
 * 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:
879 880 881 882 883 884 885 886 887 888
 *   - title: (required) The human readable name of the ranking mechanism.
 *   - join: (optional) The 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.
 *   - score: (required) The 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
889
 *     0 and 1; be careful not to cast the entire score to an integer by