node.api.php 36.5 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
 *   - 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)
46
 * - Updating an existing node (calling $node->save() on an existing node):
47 48
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
49
 *   - hook_entity_presave() (all)
50 51 52 53 54
 *   - 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)
55
 * - Loading a node (calling node_load(), node_load_multiple(), entity_load(),
56
 *   or entity_load_multiple() with $entity_type of 'node'):
57 58 59 60
 *   - 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
61
 *   node_view() is a loaded node, so the Loading steps above are already done):
62
 *   - field_attach_prepare_view()
63
 *   - hook_entity_prepare_view() (all)
64 65
 *   - field_attach_view()
 *   - hook_node_view() (all)
66 67 68
 *   - hook_entity_view() (all)
 *   - hook_node_view_alter() (all)
 *   - hook_entity_view_alter() (all)
69 70 71 72
 * - 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()
73
 *   - hook_entity_prepare_view() (all)
74 75
 *   - field_attach_view()
 *   - hook_node_view() (all)
76
 *   - hook_entity_view() (all)
77
 *   - hook_node_view_alter() (all)
78
 *   - hook_entity_view_alter() (all)
79
 * - Deleting a node (calling $node->delete() or entity_delete_multiple()):
80
 *   - Node is loaded (see Loading section above)
81 82
 *   - hook_node_predelete() (all)
 *   - hook_entity_predelete() (all)
83
 *   - Node and revision information are deleted from database
84 85
 *   - hook_node_delete() (all)
 *   - hook_entity_delete() (all)
86 87 88 89
 * - 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)
90 91
 * - 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):
92 93
 *   - hook_node_prepare_form() (all)
 *   - hook_entity_prepare_form() (all)
94 95 96 97 98 99 100 101 102
 *   - 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)
103
 *   - comment_node_update_index() is called.
104 105 106 107 108 109 110 111
 *   - 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)
 * @}
 */

112 113 114 115 116 117 118 119
/**
 * @addtogroup hooks
 * @{
 */

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

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

286 287 288 289
    return $grants;
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

/**
688
 * Act on a node being indexed for searching.
689
 *
690 691
 * 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.
692
 *
693
 * @param \Drupal\Core\Entity\EntityInterface $node
694
 *   The node being indexed.
695 696
 * @param $langcode
 *   Language code of the variant of the node being indexed.
697
 *
698 699
 * @return string
 *   Additional node information to be indexed.
700 701
 *
 * @ingroup node_api_hooks
702
 */
703
function hook_node_update_index(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
704
  $text = '';
705
  $comments = db_query('SELECT subject, comment, format FROM {comment} WHERE nid = :nid AND status = :status', array(':nid' => $node->id(), ':status' => COMMENT_PUBLISHED));
706
  foreach ($comments as $comment) {
707
    $text .= '<h2>' . check_plain($comment->subject->value) . '</h2>' . $comment->comment_body->processed;
708 709 710 711 712
  }
  return $text;
}

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

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

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

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

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

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
/**
 * 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:
873 874 875 876 877 878 879 880 881 882
 *   - 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
883
 *     0 and 1; be careful not to cast the entire score to an integer by
884 885 886
 *     inadvertently introducing a variable argument.
 *   - arguments: (optional) If any arguments are required for the score, they
 *     can be specified in an array here.
887 888
 *
 * @ingroup node_api_hooks
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
 */
function hook_ranking() {
  // If voting is disabled, we can avoid returning the array, no hard feelings.
  if (variable_get('vote_node_enabled', TRUE)) {
    return array(
      'vote_average' => array(
        'title' => t('Average vote'),
        // Note that we use i.sid, the search index's search item id, rather than
        // n.nid.
        'join' => 'LEFT JOIN {vote_node_data} vote_node_data ON vote_node_data.nid = i.sid',
        // The highest possible score should be 1, and the lowest possible score,
        // always 0, should be 0.
        'score' => 'vote_node_data.average / CAST(%f AS DECIMAL)',
        // Pass in the highest possible voting score as a decimal argument.
        'arguments' => array(variable_get('vote_score_max', 5)),
      ),
    );
  }
}

909
/**
910
 * Respond to node type creation.
911
 *
912 913
 * @param \Drupal\node\NodeTypeInterface $type
 *   The node type entity that was created.
914
 */
915 916
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())));
917 918
}

919
/**
920
 * Respond to node type updates.
921
 *
922 923
 * @param \Drupal\node\NodeTypeInterface $type
 *   The node type entity that was updated.
924
 */
925 926 927
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())));
928 929 930
  }
}

931
/**
932
 * Respond to node type deletion.
933
 *
934 935
 * @param \Drupal\node\NodeTypeInterface $type
 *   The node type entity that was deleted.
936
 */
937 938
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())));
939 940
}

941 942 943
/**
 * @} End of "addtogroup hooks".
 */