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

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

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

13 14 15
/**
 * @defgroup node_api_hooks Node API Hooks
 * @{
16
 * Functions to define and modify content types.
17 18
 *
 * Each content type is maintained by a primary module, which is either
19
 * node.module (for content types created in the user interface) or the module
20
 * that defines the content type by providing configuration file.
21
 *
22 23 24
 * 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:
25 26
 * - 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
27
 *   example, hook_node_insert() is invoked on all modules when creating a forum
28
 *   node.
29 30 31 32 33 34 35 36
 * - 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:
37 38 39
 * - Instantiating a new node:
 *   - hook_node_create() (all)
 *   - hook_entity_create() (all)
40
 * - Creating a new node (calling $node->save() on a new node):
41 42
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
43
 *   - hook_entity_presave() (all)
44 45 46 47 48
 *   - 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)
49
 * - Updating an existing node (calling $node->save() on an existing node):
50 51
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
52
 *   - hook_entity_presave() (all)
53 54 55 56 57
 *   - 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)
58
 * - Loading a node (calling node_load(), node_load_multiple(), entity_load(),
59
 *   or entity_load_multiple() with $entity_type of 'node'):
60 61 62 63
 *   - 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
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
 *   - Node and revision information are deleted from database
87 88
 *   - hook_node_delete() (all)
 *   - hook_entity_delete() (all)
89 90 91 92
 * - 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)
93 94
 * - 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):
95 96
 *   - hook_node_prepare_form() (all)
 *   - hook_entity_prepare_form() (all)
97 98 99 100
 *   - field_attach_form()
 * - Validating a node during editing form submit (calling
 *   node_form_validate()):
 *   - hook_node_validate() (all)
101
 * - Searching (using the 'node_search' plugin):
102 103 104 105
 *   - 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)
106
 *   - comment_node_update_index() is called (this adds "N comments" text)
107
 *   - hook_node_search_result() (all)
108
 * - Search indexing (calling updateIndex() on the 'node_search' plugin):
109 110 111 112 113 114
 *   - Node is loaded (see Loading section above)
 *   - Node is prepared for viewing (see Viewing a single node above)
 *   - hook_node_update_index() (all)
 * @}
 */

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

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

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

289 290 291 292
    return $grants;
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

/**
617
 * Act on a node being displayed as a search result.
618
 *
619 620
 * This hook is invoked from the node search plugin during search execution,
 * after loading and rendering the node.
621
 *
622
 * @param \Drupal\Core\Entity\EntityInterface $node
623
 *   The node being displayed in a search result.
624 625
 * @param $langcode
 *   Language code of result being displayed.
626
 *
627 628
 * @return array
 *   Extra information to be displayed with search result. This information
629 630 631
 *   should be presented as an associative array. It will be concatenated with
 *   the post information (last updated, author) in the default search result
 *   theming.
632 633
 *
 * @see template_preprocess_search_result()
634
 * @see search-result.html.twig
635 636
 *
 * @ingroup node_api_hooks
637
 */
638
function hook_node_search_result(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
639 640
  $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'));
641 642 643
}

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

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

/**
691
 * Act on a node being indexed for searching.
692
 *
693 694
 * This hook is invoked during search indexing, after loading, and after the
 * result of rendering is added as $node->rendered to the node object.
695
 *
696
 * @param \Drupal\Core\Entity\EntityInterface $node
697
 *   The node being indexed.
698 699
 * @param $langcode
 *   Language code of the variant of the node being indexed.
700
 *
701 702
 * @return string
 *   Additional node information to be indexed.
703 704
 *
 * @ingroup node_api_hooks
705
 */
706
function hook_node_update_index(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
707
  $text = '';
708 709 710
  $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);
711 712 713 714 715
  }
  return $text;
}

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

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

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

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

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

849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
/**
 * 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:
875 876 877 878 879 880 881 882 883 884
 *   - 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
885
 *     0 and 1; be careful not to cast the entire score to an integer by
886 887 888
 *     inadvertently introducing a variable argument.
 *   - arguments: (optional) If any arguments are required for the score, they
 *     can be specified in an array here.
889 890
 *
 * @ingroup node_api_hooks
891 892 893
 */
function hook_ranking() {
  // If voting is disabled, we can avoid returning the array, no hard feelings.
894
  if (\Drupal::config('vote.settings')->get('node_enabled')) {
895 896 897 898 899 900 901 902 903 904
    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.
905
        'arguments' => array(\Drupal::config('vote.settings').get('score_max')),
906 907 908 909 910
      ),
    );
  }
}

911
/**
912
 * Respond to node type creation.
913
 *
914 915
 * @param \Drupal\node\NodeTypeInterface $type
 *   The node type entity that was created.
916
 */
917 918
function hook_node_type_insert(\Drupal\node\NodeTypeInterface $type) {
  drupal_set_message(t('You have just created a content type with a machine name %type.', array('%type' => $type->id())));
919 920
}

921
/**
922
 * Respond to node type updates.
923
 *
924 925
 * @param \Drupal\node\NodeTypeInterface $type
 *   The node type entity that was updated.
926
 */
927 928 929
function hook_node_type_update(\Drupal\node\NodeTypeInterface $type) {
  if ($type->original->id() != $type->id()) {
    drupal_set_message(t('You have just changed the machine name of a content type from %old_type to %type.', array('%old_type' => $type->original->id(), '%type' => $type->id())));
930 931 932
  }
}

933
/**
934
 * Respond to node type deletion.
935
 *
936 937
 * @param \Drupal\node\NodeTypeInterface $type
 *   The node type entity that was deleted.
938
 */
939 940
function hook_node_type_delete(\Drupal\node\NodeTypeInterface $type) {
  drupal_set_message(t('You have just deleted a content type with the machine name %type.', array('%type' => $type->id())));
941 942
}

943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
/**
 * Alter the links of a node.
 *
 * @param array &$links
 *   A renderable array representing the node links.
 * @param \Drupal\node\NodeInterface $entity
 *   The node being rendered.
 * @param array &$context
 *   Various aspects of the context in which the node links are going to be
 *   displayed, with the following keys:
 *   - 'view_mode': the view mode in which the comment is being viewed
 *   - 'langcode': the language in which the comment is being viewed
 *
 * @see \Drupal\node\NodeViewBuilder::renderLinks()
 * @see \Drupal\node\NodeViewBuilder::buildLinks()
 */
function hook_node_links_alter(array &$links, NodeInterface $entity, array &$context) {
  $links['mymodule'] = array(
    '#theme' => 'links__node__mymodule',
    '#attributes' => array('class' => array('links', 'inline')),
    '#links' => array(
      'node-report' => array(
        'title' => t('Report'),
        'href' => "node/{$entity->id()}/report",
        'html' => TRUE,
        'query' => array('token' => \Drupal::getContainer()->get('csrf_token')->get("node/{$entity->id()}/report")),
      ),
    ),
  );
}

974 975 976
/**
 * @} End of "addtogroup hooks".
 */