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

3
use Drupal\Core\Entity\EntityInterface;
4 5
use Drupal\Component\Utility\String;
use Drupal\Component\Utility\Xss;
6

7 8 9 10 11
/**
 * @file
 * Hooks provided by the Node module.
 */

12 13 14
/**
 * @defgroup node_api_hooks Node API Hooks
 * @{
15
 * Functions to define and modify content types.
16 17
 *
 * Each content type is maintained by a primary module, which is either
18
 * node.module (for content types created in the user interface) or the module
19
 * that defines the content type by providing configuration file.
20
 *
21 22 23
 * 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:
24 25
 * - 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
26
 *   example, hook_node_insert() is invoked on all modules when creating a forum
27
 *   node.
28 29 30 31 32 33 34 35
 * - 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:
36 37 38
 * - Instantiating a new node:
 *   - hook_node_create() (all)
 *   - hook_entity_create() (all)
39
 * - Creating a new node (calling $node->save() on a new node):
40 41
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
42
 *   - hook_entity_presave() (all)
43 44 45 46 47
 *   - Node and revision records are written to the database
 *   - hook_node_insert() (all)
 *   - hook_entity_insert() (all)
 *   - hook_node_access_records() (all)
 *   - hook_node_access_records_alter() (all)
48
 * - Updating an existing node (calling $node->save() on an existing node):
49 50
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
51
 *   - hook_entity_presave() (all)
52 53 54 55 56
 *   - Node and revision records are written to the database
 *   - 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
 *   - Node and revision information is read from database.
 *   - hook_entity_load() (all)
 *   - hook_node_load() (all)
 * - Viewing a single node (calling node_view() - note that the input to
63
 *   node_view() is a loaded node, so the Loading steps above are already done):
64
 *   - field_attach_prepare_view()
65
 *   - hook_entity_prepare_view() (all)
66 67
 *   - field_attach_view()
 *   - hook_node_view() (all)
68 69 70
 *   - hook_entity_view() (all)
 *   - hook_node_view_alter() (all)
 *   - hook_entity_view_alter() (all)
71 72 73 74
 * - 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()
75
 *   - hook_entity_prepare_view() (all)
76 77
 *   - field_attach_view()
 *   - hook_node_view() (all)
78
 *   - hook_entity_view() (all)
79
 *   - hook_node_view_alter() (all)
80
 *   - hook_entity_view_alter() (all)
81
 * - Deleting a node (calling $node->delete() or entity_delete_multiple()):
82
 *   - Node is loaded (see Loading section above)
83 84
 *   - hook_node_predelete() (all)
 *   - hook_entity_predelete() (all)
85
 *   - Node and revision information are deleted from database
86 87
 *   - hook_node_delete() (all)
 *   - hook_entity_delete() (all)
88 89 90 91
 * - 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)
92 93
 * - 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):
94 95
 *   - hook_node_prepare_form() (all)
 *   - hook_entity_prepare_form() (all)
96 97 98 99
 *   - field_attach_form()
 * - Validating a node during editing form submit (calling
 *   node_form_validate()):
 *   - hook_node_validate() (all)
100
 * - Searching (using the 'node_search' plugin):
101 102 103 104
 *   - 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)
105
 *   - comment_node_update_index() is called (this adds "N comments" text)
106
 *   - hook_node_search_result() (all)
107
 * - Search indexing (calling updateIndex() on the 'node_search' plugin):
108 109 110 111 112 113
 *   - Node is loaded (see Loading section above)
 *   - Node is prepared for viewing (see Viewing a single node above)
 *   - hook_node_update_index() (all)
 * @}
 */

114 115 116 117 118 119 120 121
/**
 * @addtogroup hooks
 * @{
 */

/**
 * Inform the node access system what permissions the user has.
 *
122 123 124 125
 * 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.
126
 *
127
 * The realms and grant IDs can be arbitrarily defined by your node access
128 129 130 131
 * 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.
132
 *
133 134 135 136 137
 * 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.
138
 *
139 140 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
 * 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.
 *
168
 * @param $account
169 170
 *   The user object whose grants are requested.
 * @param $op
171
 *   The node operation to be performed, such as 'view', 'update', or 'delete'.
172
 *
173
 * @return
174 175
 *   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.
176 177 178
 *
 * For a detailed example, see node_access_example.module.
 *
179 180
 * @see node_access_view_all_nodes()
 * @see node_access_rebuild()
181 182 183 184 185 186
 * @ingroup node_access
 */
function hook_node_grants($account, $op) {
  if (user_access('access private content', $account)) {
    $grants['example'] = array(1);
  }
187
  $grants['example_owner'] = array($account->id());
188 189 190 191 192 193
  return $grants;
}

/**
 * Set permissions for a node to be written to the database.
 *
194 195 196
 * 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
197 198
 * node.
 *
199 200 201 202 203 204
 * 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.
 *
205 206 207
 * Note that the grant values in the return value from your hook must be
 * integers and not boolean TRUE and FALSE.
 *
208 209 210 211
 * 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().
212
 * - 'grant_view': If set to 1 a user that has been identified as a member
213
 *   of this gid within this realm can view this node. This should usually be
214
 *   set to $node->isPublished(). Failure to do so may expose unpublished content
215
 *   to some users.
216
 * - 'grant_update': If set to 1 a user that has been identified as a member
217
 *   of this gid within this realm can edit this node.
218
 * - 'grant_delete': If set to 1 a user that has been identified as a member
219
 *   of this gid within this realm can delete this node.
220 221 222 223 224 225 226 227
 * - 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.
228
 *
229 230
 * A "deny all" grant may be used to deny all access to a particular node or
 * node translation:
231 232 233 234 235 236 237
 * @code
 * $grants[] = array(
 *   'realm' => 'all',
 *   'gid' => 0,
 *   'grant_view' => 0,
 *   'grant_update' => 0,
 *   'grant_delete' => 0,
238
 *   'langcode' => 'ca',
239 240
 * );
 * @endcode
241 242 243 244 245
 * 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.
246
 *
247
 * @param \Drupal\Core\Entity\EntityInterface $node
248 249 250 251 252
 *   The node that has just been saved.
 *
 * @return
 *   An array of grants as defined above.
 *
253
 * @see node_access_write_grants()
254
 * @see hook_node_access_records_alter()
255 256
 * @ingroup node_access
 */
257
function hook_node_access_records(\Drupal\node\NodeInterface $node) {
258
  // We only care about the node if it has been marked private. If not, it is
259
  // treated just like any other node and we completely ignore it.
260
  if ($node->private->value) {
261
    $grants = array();
262
    // Only published Catalan translations of private nodes should be viewable
263
    // to all users. If we fail to check $node->isPublished(), all users would be able
264
    // to view an unpublished node.
265
    if ($node->isPublished()) {
266 267 268 269 270 271
      $grants[] = array(
        'realm' => 'example',
        'gid' => 1,
        'grant_view' => 1,
        'grant_update' => 0,
        'grant_delete' => 0,
272
        'langcode' => 'ca'
273 274
      );
    }
275
    // For the example_author array, the GID is equivalent to a UID, which
276 277 278
    // 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.
279 280
    $grants[] = array(
      'realm' => 'example_author',
281
      'gid' => $node->getAuthorId(),
282 283 284
      'grant_view' => 1,
      'grant_update' => 1,
      'grant_delete' => 1,
285
      'langcode' => 'ca'
286
    );
287

288 289 290 291
    return $grants;
  }
}

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

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

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

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

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

424
/**
425
 * Respond to deletion of a node revision.
426
 *
427
 * This hook is invoked from node_revision_delete() after the revision has been
428
 * removed from the node_revision table, and before field values are deleted.
429
 *
430
 * @param \Drupal\Core\Entity\EntityInterface $node
431
 *   The node revision (node object) that is being deleted.
432 433
 *
 * @ingroup node_api_hooks
434
 */
435
function hook_node_revision_delete(\Drupal\Core\Entity\EntityInterface $node) {
436
  db_delete('mytable')
437
    ->condition('vid', $node->getRevisionId())
438
    ->execute();
439 440 441
}

/**
442
 * Respond to creation of a new node.
443
 *
444
 * This hook is invoked from $node->save() after the database query that will
445
 * insert the node into the node table is scheduled for execution, and after
446
 * field values are saved.
447 448 449 450
 *
 * 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
451
 * and $node->save() goes out of scope. You should not rely on data in the
452 453
 * 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
454
 * immediately. Check $node->save() and db_transaction() for more info.
455
 *
456
 * @param \Drupal\Core\Entity\EntityInterface $node
457
 *   The node that is being created.
458 459
 *
 * @ingroup node_api_hooks
460
 */
461
function hook_node_insert(\Drupal\Core\Entity\EntityInterface $node) {
462 463
  db_insert('mytable')
    ->fields(array(
464
      'nid' => $node->id(),
465 466 467
      'extra' => $node->extra,
    ))
    ->execute();
468 469
}

470 471 472 473 474 475
/**
 * 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.
 *
476
 * @param \Drupal\Core\Entity\EntityInterface $node
477 478 479 480
 *   The node object.
 *
 * @ingroup node_api_hooks
 */
481
function hook_node_create(\Drupal\Core\Entity\EntityInterface $node) {
482 483 484 485 486
  if (!isset($node->foo)) {
    $node->foo = 'some_initial_value';
  }
}

487
/**
488 489
 * Act on arbitrary nodes being loaded from the database.
 *
490 491 492 493
 * 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.
494 495
 *
 * This hook is invoked during node loading, which is handled by entity_load(),
496
 * via classes Drupal\node\NodeStorageController and
497 498 499 500
 * Drupal\Core\Entity\DatabaseStorageController. After the node information and
 * field values are read from the database or the entity cache,
 * hook_entity_load() is invoked on all implementing modules, and finally
 * hook_node_load() is invoked on all implementing modules.
501
 *
502
 * @param $nodes
503
 *   An array of the nodes being loaded, keyed by nid.
504
 * @param $types
505
 *   An array containing the node types present in $nodes. Allows for an early
506
 *   return for modules that only support certain node types.
507 508
 *
 * For a detailed usage example, see nodeapi_example.module.
509 510
 *
 * @ingroup node_api_hooks
511
 */
512
function hook_node_load($nodes, $types) {
513
  // Decide whether any of $types are relevant to our purposes.
514
  $types_we_want_to_process = \Drupal::config('my_types')->get('types');
515 516 517 518 519 520 521
  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;
    }
522 523 524
  }
}

525
/**
526
 * Controls access to a node.
527 528 529 530
 *
 * 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.
 *
531 532
 * 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"
533 534 535
 * permission may always view and edit content through the administrative
 * interface.
 *
536 537 538 539
 * 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.
540
 *
541 542 543 544
 * 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.
 *
545
 * @param \Drupal\Core\Entity\EntityInterface|string $node
546
 *   Either a node entity or the machine name of the content type on which to
547
 *   perform the access check.
548
 * @param string $op
549 550 551 552 553
 *   The operation to be performed. Possible values:
 *   - "create"
 *   - "delete"
 *   - "update"
 *   - "view"
554
 * @param object $account
555
 *   The user object to perform the access check operation on.
556 557
 * @param object $langcode
 *   The language code to perform the access check operation on.
558
 *
559
 * @return string
560 561 562
 *   - 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.
563 564
 *
 * @ingroup node_access
565
 */
566 567
function hook_node_access(\Drupal\node\NodeInterface $node, $op, $account, $langcode) {
  $type = is_string($node) ? $node : $node->getType();
568

569 570
  $configured_types = node_permissions_get_configured_types();
  if (isset($configured_types[$type])) {
571 572 573 574 575
    if ($op == 'create' && user_access('create ' . $type . ' content', $account)) {
      return NODE_ACCESS_ALLOW;
    }

    if ($op == 'update') {
576
      if (user_access('edit any ' . $type . ' content', $account) || (user_access('edit own ' . $type . ' content', $account) && ($account->id() == $node->getAuthorId()))) {
577 578 579 580 581
        return NODE_ACCESS_ALLOW;
      }
    }

    if ($op == 'delete') {
582
      if (user_access('delete any ' . $type . ' content', $account) || (user_access('delete own ' . $type . ' content', $account) && ($account->id() == $node->getAuthorId()))) {
583 584 585 586 587 588 589 590 591 592
        return NODE_ACCESS_ALLOW;
      }
    }
  }

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


593
/**
594 595
 * Act on a node object about to be shown on the add/edit form.
 *
596
 * This hook is invoked from NodeFormController::prepareEntity().
597
 *
598 599 600 601 602 603 604 605
 * @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.
606 607
 *
 * @ingroup node_api_hooks
608
 */
609
function hook_node_prepare_form(\Drupal\node\NodeInterface $node, $form_display, $operation, array &$form_state) {
610 611
  if (!isset($node->my_rating)) {
    $node->my_rating = \Drupal::config("my_rating_{$node->bundle()}")->get('enabled');
612 613 614 615
  }
}

/**
616
 * Act on a node being displayed as a search result.
617
 *
618 619
 * This hook is invoked from the node search plugin during search execution,
 * after loading and rendering the node.
620
 *
621
 * @param \Drupal\Core\Entity\EntityInterface $node
622
 *   The node being displayed in a search result.
623 624
 * @param $langcode
 *   Language code of result being displayed.
625
 *
626 627
 * @return array
 *   Extra information to be displayed with search result. This information
628 629 630
 *   should be presented as an associative array. It will be concatenated with
 *   the post information (last updated, author) in the default search result
 *   theming.
631 632 633
 *
 * @see template_preprocess_search_result()
 * @see search-result.tpl.php
634 635
 *
 * @ingroup node_api_hooks
636
 */
637
function hook_node_search_result(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
638 639
  $rating = db_query('SELECT SUM(points) FROM {my_rating} WHERE nid = :nid', array('nid' => $node->id()))->fetchField();
  return array('rating' => format_plural($rating, '1 point', '@count points'));
640 641 642
}

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

/**
663 664
 * Respond to updates to a node.
 *
665
 * This hook is invoked from $node->save() after the database query that will
666 667
 * update node in the node table is scheduled for execution, and after field
 * values are saved.
668 669 670 671
 *
 * 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
672
 * and $node->save() goes out of scope. You should not rely on data in the
673 674
 * 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
675
 * immediately. Check $node->save() and db_transaction() for more info.
676
 *
677
 * @param \Drupal\Core\Entity\EntityInterface $node
678
 *   The node that is being updated.
679 680
 *
 * @ingroup node_api_hooks
681
 */
682
function hook_node_update(\Drupal\Core\Entity\EntityInterface $node) {
683 684
  db_update('mytable')
    ->fields(array('extra' => $node->extra))
685
    ->condition('nid', $node->id())
686
    ->execute();
687 688 689
}

/**
690
 * Act on a node being indexed for searching.
691
 *
692 693
 * This hook is invoked during search indexing, after loading, and after the
 * result of rendering is added as $node->rendered to the node object.
694
 *
695
 * @param \Drupal\Core\Entity\EntityInterface $node
696
 *   The node being indexed.
697 698
 * @param $langcode
 *   Language code of the variant of the node being indexed.
699
 *
700 701
 * @return string
 *   Additional node information to be indexed.
702 703
 *
 * @ingroup node_api_hooks
704
 */
705
function hook_node_update_index(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
706
  $text = '';
707 708 709
  $ratings = db_query('SELECT title, description FROM {my_ratings} WHERE nid = :nid', array(':nid' => $node->id()));
  foreach ($ratings as $rating) {
    $text .= '<h2>' . String::checkPlain($rating->title) . '</h2>' . Xss::filter($rating->description);
710 711 712 713 714
  }
  return $text;
}

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

745 746 747 748 749 750 751 752
/**
 * 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
753 754
 * properties. See hook_field_attach_extract_form_values() for customizing
 * field-related properties.
755
 *
756
 * @param \Drupal\Core\Entity\EntityInterface $node
757
 *   The node entity being updated in response to a form submission.
758 759 760 761 762 763 764
 * @param $form
 *   The form being used to edit the node.
 * @param $form_state
 *   The form state array.
 *
 * @ingroup node_api_hooks
 */
765
function hook_node_submit(\Drupal\Core\Entity\EntityInterface $node, $form, &$form_state) {
766 767 768 769 770 771 772
  // 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']);
  }
}

773
/**
774
 * Act on a node that is being assembled before rendering.
775
 *
776 777 778
 * 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().
779
 *
780
 * When $view_mode is 'rss', modules can also add extra RSS elements and
781 782
 * namespaces to $node->rss_elements and $node->rss_namespaces respectively for
 * the RSS item generated for this node.
783
 * For details on how this is used, see node_feed().
784
 *
785
 * @param \Drupal\Core\Entity\EntityInterface $node
786
 *   The node that is being assembled for rendering.
787
 * @param \Drupal\entity\Entity\EntityDisplay $display
788 789 790
 *   The entity_display object holding the display options configured for the
 *   node components.
 * @param string $view_mode
791
 *   The $view_mode parameter from node_view().
792
 * @param string $langcode
793
 *   The language code used for rendering.
794
 *
795
 * @see forum_node_view()
796 797
 * @see hook_entity_view()
 *
798
 * @ingroup node_api_hooks
799
 */
800
function hook_node_view(\Drupal\Core\Entity\EntityInterface $node, \Drupal\entity\Entity\EntityDisplay $display, $view_mode, $langcode) {
801 802 803 804 805 806 807 808 809
  // 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',
    );
  }
810 811
}

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

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