node.api.php 51.8 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 17
 * node.module (for content types created in the user interface) or the module
 * that implements hook_node_info() to define the content type.
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
 * - Node-type-specific hooks: These hooks are only invoked on the primary
 *   module, using the "base" return component of hook_node_info() as the
24 25 26
 *   function prefix.  For example, forum.module defines the base for the Forum
 *   content type as "forum", so during creation of a forum node, hook_insert() is
 *   only invoked by calling forum_insert().
27 28
 * - 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
29
 *   example, hook_node_insert() is invoked on all modules when creating a forum
30
 *   node.
31 32 33 34 35 36 37 38
 * - 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:
39 40 41
 * - Instantiating a new node:
 *   - hook_node_create() (all)
 *   - hook_entity_create() (all)
42 43 44
 * - Creating a new node (calling node_save() on a new node):
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
45
 *   - hook_entity_presave() (all)
46 47 48 49 50 51 52 53 54 55
 *   - Node and revision records are written to the database
 *   - hook_insert() (node-type-specific)
 *   - field_attach_insert()
 *   - hook_node_insert() (all)
 *   - hook_entity_insert() (all)
 *   - hook_node_access_records() (all)
 *   - hook_node_access_records_alter() (all)
 * - Updating an existing node (calling node_save() on an existing node):
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
56
 *   - hook_entity_presave() (all)
57 58 59 60 61 62 63
 *   - Node and revision records are written to the database
 *   - hook_update() (node-type-specific)
 *   - field_attach_update()
 *   - hook_node_update() (all)
 *   - hook_entity_update() (all)
 *   - hook_node_access_records() (all)
 *   - hook_node_access_records_alter() (all)
64
 * - Loading a node (calling node_load(), node_load_multiple(), entity_load(),
65
 *   or entity_load_multiple() with $entity_type of 'node'):
66 67 68 69 70 71
 *   - Node and revision information is read from database.
 *   - hook_load() (node-type-specific)
 *   - field_attach_load_revision() and field_attach_load()
 *   - hook_entity_load() (all)
 *   - hook_node_load() (all)
 * - Viewing a single node (calling node_view() - note that the input to
72
 *   node_view() is a loaded node, so the Loading steps above are already done):
73 74
 *   - hook_view() (node-type-specific)
 *   - field_attach_prepare_view()
75
 *   - hook_entity_prepare_view() (all)
76 77
 *   - field_attach_view()
 *   - hook_node_view() (all)
78 79 80
 *   - hook_entity_view() (all)
 *   - hook_node_view_alter() (all)
 *   - hook_entity_view_alter() (all)
81 82 83 84
 * - 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()
85
 *   - hook_entity_prepare_view() (all)
86 87 88
 *   - hook_view() (node-type-specific)
 *   - field_attach_view()
 *   - hook_node_view() (all)
89
 *   - hook_entity_view() (all)
90
 *   - hook_node_view_alter() (all)
91
 *   - hook_entity_view_alter() (all)
92 93 94
 * - Deleting a node (calling node_delete() or node_delete_multiple()):
 *   - Node is loaded (see Loading section above)
 *   - hook_delete() (node-type-specific)
95 96
 *   - hook_node_predelete() (all)
 *   - hook_entity_predelete() (all)
97
 *   - field_attach_delete()
98
 *   - Node and revision information are deleted from database
99 100
 *   - hook_node_delete() (all)
 *   - hook_entity_delete() (all)
101 102 103 104 105
 * - Deleting a node revision (calling node_revision_delete()):
 *   - Node is loaded (see Loading section above)
 *   - Revision information is deleted from database
 *   - hook_node_revision_delete() (all)
 *   - field_attach_delete_revision()
106 107
 * - 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):
108
 *   - hook_prepare() (node-type-specific)
109
 *   - hook_node_prepare() (all)
110 111 112 113 114 115 116 117 118 119 120 121
 *   - hook_form() (node-type-specific)
 *   - field_attach_form()
 * - Validating a node during editing form submit (calling
 *   node_form_validate()):
 *   - hook_validate() (node-type-specific)
 *   - hook_node_validate() (all)
 *   - field_attach_form_validate()
 * - 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)
122
 *   - comment_node_update_index() is called.
123 124 125 126 127 128 129 130
 *   - 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)
 * @}
 */

131 132 133 134 135 136 137 138
/**
 * @addtogroup hooks
 * @{
 */

/**
 * Inform the node access system what permissions the user has.
 *
139 140 141 142
 * 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.
143
 *
144
 * The realms and grant IDs can be arbitrarily defined by your node access
145 146 147 148
 * 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.
149
 *
150 151 152 153 154
 * 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.
155
 *
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
 * 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.
 *
185
 * @param $account
186 187
 *   The user object whose grants are requested.
 * @param $op
188
 *   The node operation to be performed, such as 'view', 'update', or 'delete'.
189
 *
190
 * @return
191 192
 *   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.
193 194 195
 *
 * For a detailed example, see node_access_example.module.
 *
196 197
 * @see node_access_view_all_nodes()
 * @see node_access_rebuild()
198 199 200 201 202 203
 * @ingroup node_access
 */
function hook_node_grants($account, $op) {
  if (user_access('access private content', $account)) {
    $grants['example'] = array(1);
  }
204
  $grants['example_owner'] = array($account->uid);
205 206 207 208 209 210
  return $grants;
}

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

305 306 307 308
    return $grants;
  }
}

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
/**
 * 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.
 *
324 325
 * A module may deny all access to a node by setting $grants to an empty array.
 *
326
 * @param $grants
327
 *   The $grants array returned by hook_node_access_records().
328
 * @param \Drupal\Core\Entity\EntityInterface $node
329 330 331
 *   The node for which the grants were acquired.
 *
 * The preferred use of this hook is in a module that bridges multiple node
332 333
 * access modules with a configurable behavior, as shown in the example with the
 * 'is_preview' field.
334
 *
335 336 337
 * @see hook_node_access_records()
 * @see hook_node_grants()
 * @see hook_node_grants_alter()
338 339
 * @ingroup node_access
 */
340
function hook_node_access_records_alter(&$grants, Drupal\Core\Entity\EntityInterface $node) {
341 342 343 344 345 346 347 348 349
  // 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);
350 351 352 353 354 355 356
  }
}

/**
 * Alter user access rules when trying to view, edit or delete a node.
 *
 * Node access modules establish rules for user access to content.
357 358 359 360 361
 * 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.
362 363 364 365
 *
 * The resulting grants are then checked against the records stored in the
 * {node_access} table to determine if the operation may be completed.
 *
366 367
 * A module may deny all access to a user by setting $grants to an empty array.
 *
368 369
 * 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
370 371
 * permissions assigned to a user role, or specific attributes of a user
 * account.
372
 *
373
 * @param $grants
374 375 376 377 378 379
 *   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'.
 *
380 381 382
 * @see hook_node_grants()
 * @see hook_node_access_records()
 * @see hook_node_access_records_alter()
383 384 385 386 387 388 389 390 391 392
 * @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());
393

394 395 396
  if ($op != 'view' && !empty($restricted)) {
    // Now check the roles for this account against the restrictions.
    foreach ($restricted as $role_id) {
397
      if (isset($account->roles[$role_id])) {
398 399 400 401 402 403
        $grants = array();
      }
    }
  }
}

404 405 406
/**
 * Add mass node operations.
 *
407 408 409 410 411
 * This hook enables modules to inject custom operations into the mass
 * operations dropdown found at admin/content, by associating a callback
 * function with the operation, which is called when the form is submitted. The
 * callback function receives one initial argument, which is an array of the
 * checked nodes.
412 413 414 415
 *
 * @return
 *   An array of operations. Each operation is an associative array that may
 *   contain the following key-value pairs:
416
 *   - label: (required) The label for the operation, displayed in the dropdown
417
 *     menu.
418 419
 *   - callback: (required) The function to call for the operation.
 *   - callback arguments: (optional) An array of additional arguments to pass
420
 *     to the callback function.
421 422 423
 */
function hook_node_operations() {
  $operations = array(
424 425 426 427
    'publish' => array(
      'label' => t('Publish selected content'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED)),
428
    ),
429 430 431 432
    'unpublish' => array(
      'label' => t('Unpublish selected content'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_NOT_PUBLISHED)),
433
    ),
434 435 436 437
    'promote' => array(
      'label' => t('Promote selected content to front page'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED, 'promote' => NODE_PROMOTED)),
438 439
    ),
    'demote' => array(
440 441 442
      'label' => t('Demote selected content from front page'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('promote' => NODE_NOT_PROMOTED)),
443
    ),
444 445 446 447 448 449 450 451 452
    'sticky' => array(
      'label' => t('Make selected content sticky'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED, 'sticky' => NODE_STICKY)),
    ),
    'unsticky' => array(
      'label' => t('Make selected content not sticky'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('sticky' => NODE_NOT_STICKY)),
453 454
    ),
    'delete' => array(
455 456
      'label' => t('Delete selected content'),
      'callback' => NULL,
457 458 459 460 461
    ),
  );
  return $operations;
}

462
/**
463
 * Act before node deletion.
464
 *
465
 * This hook is invoked from node_delete_multiple() after the type-specific
466
 * hook_delete() has been invoked, but before hook_entity_predelete() and
467 468
 * field_attach_delete() are called, and before the node is removed from the
 * node table in the database.
469
 *
470
 * @param \Drupal\Core\Entity\EntityInterface $node
471
 *   The node that is about to be deleted.
472
 *
473 474
 * @see hook_node_predelete()
 * @see node_delete_multiple()
475
 * @ingroup node_api_hooks
476
 */
477
function hook_node_predelete(\Drupal\Core\Entity\EntityInterface $node) {
478 479 480
  db_delete('mytable')
    ->condition('nid', $node->nid)
    ->execute();
481 482
}

483 484 485 486 487 488
/**
 * Respond to node deletion.
 *
 * This hook is invoked from node_delete_multiple() after field_attach_delete()
 * has been called and after the node has been removed from the database.
 *
489
 * @param \Drupal\Core\Entity\EntityInterface $node
490 491 492 493 494 495
 *   The node that has been deleted.
 *
 * @see hook_node_predelete()
 * @see node_delete_multiple()
 * @ingroup node_api_hooks
 */
496
function hook_node_delete(\Drupal\Core\Entity\EntityInterface $node) {
497
  drupal_set_message(t('Node: @title has been deleted', array('@title' => $node->label())));
498 499
}

500
/**
501
 * Respond to deletion of a node revision.
502
 *
503 504 505
 * This hook is invoked from node_revision_delete() after the revision has been
 * removed from the node_revision table, and before
 * field_attach_delete_revision() is called.
506
 *
507
 * @param \Drupal\Core\Entity\EntityInterface $node
508
 *   The node revision (node object) that is being deleted.
509 510
 *
 * @ingroup node_api_hooks
511
 */
512
function hook_node_revision_delete(\Drupal\Core\Entity\EntityInterface $node) {
513 514 515
  db_delete('mytable')
    ->condition('vid', $node->vid)
    ->execute();
516 517 518
}

/**
519
 * Respond to creation of a new node.
520
 *
521 522 523 524 525 526 527 528 529 530 531 532
 * This hook is invoked from node_save() after the database query that will
 * insert the node into the node table is scheduled for execution, after the
 * type-specific hook_insert() is invoked, and after field_attach_insert() is
 * called.
 *
 * 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
 * and node_save() goes out of scope. You should not rely on data in the
 * 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
 * immediately. Check node_save() and db_transaction() for more info.
533
 *
534
 * @param \Drupal\Core\Entity\EntityInterface $node
535
 *   The node that is being created.
536 537
 *
 * @ingroup node_api_hooks
538
 */
539
function hook_node_insert(\Drupal\Core\Entity\EntityInterface $node) {
540 541 542 543 544 545
  db_insert('mytable')
    ->fields(array(
      'nid' => $node->nid,
      'extra' => $node->extra,
    ))
    ->execute();
546 547
}

548 549 550 551 552 553
/**
 * 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.
 *
554
 * @param \Drupal\Core\Entity\EntityInterface $node
555 556 557 558
 *   The node object.
 *
 * @ingroup node_api_hooks
 */
559
function hook_node_create(\Drupal\Core\Entity\EntityInterface $node) {
560 561 562 563 564
  if (!isset($node->foo)) {
    $node->foo = 'some_initial_value';
  }
}

565
/**
566 567
 * Act on arbitrary nodes being loaded from the database.
 *
568 569 570 571
 * 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.
572 573
 *
 * This hook is invoked during node loading, which is handled by entity_load(),
574 575 576 577 578 579 580
 * via classes Drupal\node\NodeStorageController and
 * Drupal\Core\Entity\DatabaseStorageController. After the node information is
 * read from the database or the entity cache, hook_load() is invoked on the
 * node's content type module, then field_attach_load_revision() or
 * field_attach_load() is called, then hook_entity_load() is invoked on all
 * implementing modules, and finally hook_node_load() is invoked on all
 * implementing modules.
581
 *
582
 * @param $nodes
583
 *   An array of the nodes being loaded, keyed by nid.
584
 * @param $types
585 586 587 588
 *   An array containing the node types present in $nodes. Allows for an early
 *   return for modules that only support certain node types. However, if your
 *   module defines a content type, you can use hook_load() to respond to
 *   loading of just that content type.
589 590
 *
 * For a detailed usage example, see nodeapi_example.module.
591 592
 *
 * @ingroup node_api_hooks
593
 */
594
function hook_node_load($nodes, $types) {
595 596 597 598 599 600 601 602
  // 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;
    }
603 604 605
  }
}

606
/**
607
 * Controls access to a node.
608 609 610 611
 *
 * 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.
 *
612 613
 * 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"
614 615 616
 * permission may always view and edit content through the administrative
 * interface.
 *
617 618 619 620
 * 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.
621
 *
622 623 624 625
 * 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.
 *
626
 * @param Drupal\Core\Entity\EntityInterface|string $node
627
 *   Either a node entity or the machine name of the content type on which to
628
 *   perform the access check.
629
 * @param string $op
630 631 632 633 634
 *   The operation to be performed. Possible values:
 *   - "create"
 *   - "delete"
 *   - "update"
 *   - "view"
635
 * @param object $account
636
 *   The user object to perform the access check operation on.
637 638
 * @param object $langcode
 *   The language code to perform the access check operation on.
639
 *
640
 * @return string
641 642 643
 *   - 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.
644 645
 *
 * @ingroup node_access
646
 */
647
function hook_node_access($node, $op, $account, $langcode) {
648
  $type = is_string($node) ? $node : $node->type;
649

650 651
  $configured_types = node_permissions_get_configured_types();
  if (isset($configured_types[$type])) {
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
    if ($op == 'create' && user_access('create ' . $type . ' content', $account)) {
      return NODE_ACCESS_ALLOW;
    }

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

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

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


674
/**
675 676
 * Act on a node object about to be shown on the add/edit form.
 *
677 678
 * This hook is invoked from NodeFormController::prepareEntity() after the
 * type-specific hook_prepare() is invoked.
679
 *
680
 * @param \Drupal\Core\Entity\EntityInterface $node
681
 *   The node that is about to be shown on the add/edit form.
682 683
 *
 * @ingroup node_api_hooks
684
 */
685
function hook_node_prepare(\Drupal\Core\Entity\EntityInterface $node) {
686
  if (!isset($node->comment)) {
687
    $node->comment = variable_get("comment_$node->type", COMMENT_NODE_OPEN);
688 689 690 691
  }
}

/**
692
 * Act on a node being displayed as a search result.
693
 *
694 695
 * This hook is invoked from node_search_execute(), after node_load() and
 * node_view() have been called.
696
 *
697
 * @param \Drupal\Core\Entity\EntityInterface $node
698
 *   The node being displayed in a search result.
699 700
 * @param $langcode
 *   Language code of result being displayed.
701
 *
702 703
 * @return array
 *   Extra information to be displayed with search result. This information
704 705 706
 *   should be presented as an associative array. It will be concatenated with
 *   the post information (last updated, author) in the default search result
 *   theming.
707 708 709
 *
 * @see template_preprocess_search_result()
 * @see search-result.tpl.php
710 711
 *
 * @ingroup node_api_hooks
712
 */
713
function hook_node_search_result(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
714
  $comments = db_query('SELECT comment_count FROM {node_comment_statistics} WHERE nid = :nid', array('nid' => $node->nid))->fetchField();
715
  return array('comment' => format_plural($comments, '1 comment', '@count comments'));
716 717 718
}

/**
719
 * Act on a node being inserted or updated.
720
 *
721 722
 * This hook is invoked from node_save() before the node is saved to the
 * database.
723
 *
724
 * @param \Drupal\Core\Entity\EntityInterface $node
725
 *   The node that is being inserted or updated.
726 727
 *
 * @ingroup node_api_hooks
728
 */
729
function hook_node_presave(\Drupal\Core\Entity\EntityInterface $node) {
730 731 732 733 734 735 736 737 738
  if ($node->nid && $node->moderate) {
    // Reset votes when node is updated:
    $node->score = 0;
    $node->users = '';
    $node->votes = 0;
  }
}

/**
739 740
 * Respond to updates to a node.
 *
741 742 743 744 745 746 747 748 749 750 751 752
 * This hook is invoked from node_save() after the database query that will
 * update node in the node table is scheduled for execution, after the
 * type-specific hook_update() is invoked, and after field_attach_update() is
 * called.
 *
 * 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
 * and node_save() goes out of scope. You should not rely on data in the
 * 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
 * immediately. Check node_save() and db_transaction() for more info.
753
 *
754
 * @param \Drupal\Core\Entity\EntityInterface $node
755
 *   The node that is being updated.
756 757
 *
 * @ingroup node_api_hooks
758
 */
759
function hook_node_update(\Drupal\Core\Entity\EntityInterface $node) {
760 761 762 763
  db_update('mytable')
    ->fields(array('extra' => $node->extra))
    ->condition('nid', $node->nid)
    ->execute();
764 765 766
}

/**
767
 * Act on a node being indexed for searching.
768
 *
769 770
 * 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.
771
 *
772
 * @param \Drupal\Core\Entity\EntityInterface $node
773
 *   The node being indexed.
774 775
 * @param $langcode
 *   Language code of the variant of the node being indexed.
776
 *
777 778
 * @return string
 *   Additional node information to be indexed.
779 780
 *
 * @ingroup node_api_hooks
781
 */
782
function hook_node_update_index(\Drupal\Core\Entity\EntityInterface $node, $langcode) {
783 784 785
  $text = '';
  $comments = db_query('SELECT subject, comment, format FROM {comment} WHERE nid = :nid AND status = :status', array(':nid' => $node->nid, ':status' => COMMENT_PUBLISHED));
  foreach ($comments as $comment) {
786
    $text .= '<h2>' . check_plain($comment->subject->value) . '</h2>' . $comment->comment_body->processed;
787 788 789 790 791
  }
  return $text;
}

/**
792 793
 * Perform node validation before a node is created or updated.
 *
794
 * This hook is invoked from NodeFormController::validate(), after a user has
795 796 797
 * finished editing the node and is previewing or submitting it. It is invoked
 * at the end of all the standard validation steps, and after the type-specific
 * hook_validate() is invoked.
798
 *
799 800 801 802
 * 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
803 804
 * hook_node_presave() instead. If it is really necessary to change the node at
 * the validate stage, you can use form_set_value().
805
 *
806
 * @param \Drupal\Core\Entity\EntityInterface $node
807
 *   The node being validated.
808
 * @param $form
809
 *   The form being used to edit the node.
810 811
 * @param $form_state
 *   The form state array.
812 813
 *
 * @ingroup node_api_hooks
814
 */
815
function hook_node_validate(\Drupal\Core\Entity\EntityInterface $node, $form, &$form_state) {
816 817 818 819 820 821 822
  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.'));
    }
  }
}

823 824 825 826 827 828 829 830
/**
 * 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
831 832
 * properties. See hook_field_attach_extract_form_values() for customizing
 * field-related properties.
833
 *
834
 * @param \Drupal\Core\Entity\EntityInterface $node
835
 *   The node entity being updated in response to a form submission.
836 837 838 839 840 841 842
 * @param $form
 *   The form being used to edit the node.
 * @param $form_state
 *   The form state array.
 *
 * @ingroup node_api_hooks
 */
843
function hook_node_submit(\Drupal\Core\Entity\EntityInterface $node, $form, &$form_state) {
844 845 846 847 848 849 850
  // 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']);
  }
}

851
/**
852
 * Act on a node that is being assembled before rendering.
853
 *
854 855 856 857
 * The module may add elements to $node->content prior to rendering. This hook
 * will be called after hook_view(). The structure of $node->content is a
 * renderable array as expected by drupal_render().
 *
858
 * When $view_mode is 'rss', modules can also add extra RSS elements and
859 860
 * namespaces to $node->rss_elements and $node->rss_namespaces respectively for
 * the RSS item generated for this node.
861
 * For details on how this is used, see node_feed().
862
 *
863
 * @param \Drupal\Core\Entity\EntityInterface $node
864
 *   The node that is being assembled for rendering.
865 866 867 868
 * @param \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display
 *   The entity_display object holding the display options configured for the
 *   node components.
 * @param string $view_mode
869
 *   The $view_mode parameter from node_view().
870
 * @param string $langcode
871
 *   The language code used for rendering.
872
 *
873 874
 * @see forum_node_view()
 * @see comment_node_view()
875 876
 * @see hook_entity_view()
 *
877
 * @ingroup node_api_hooks
878
 */
879
function hook_node_view(\Drupal\Core\Entity\EntityInterface $node, \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display, $view_mode, $langcode) {
880 881 882 883 884 885 886 887 888
  // 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',
    );
  }
889 890
}

891
/**
892
 * Alter the results of node_view().
893
 *
894 895 896
 * 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.
897 898
 *
 * If the module wishes to act on the rendered HTML of the node rather than the
899
 * structured content array, it may use this hook to add a #post_render
900
 * callback.  Alternatively, it could also implement hook_preprocess_HOOK() for
901 902
 * node.html.twig. See drupal_render() and theme() documentation respectively
 * for details.
903
 *
904 905
 * @param $build
 *   A renderable array representing the node content.
906
 * @param \Drupal\Core\Entity\EntityInterface $node
907
 *   The node being rendered.
908 909 910
 * @param \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display
 *   The entity_display object holding the display options configured for the
 *   node components.
911
 *
912
 * @see node_view()
913
 * @see hook_entity_view_alter()
914 915
 *
 * @ingroup node_api_hooks
916
 */
917
function hook_node_view_alter(&$build, \Drupal\Core\Entity\EntityInterface $node, \Drupal\entity\Plugin\Core\Entity\EntityDisplay $display) {
918
  if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
919
    // Change its weight.
920
    $build['an_additional_field']['#weight'] = -10;
921
  }
922 923

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

927
/**
928
 * Define module-provided node types.
929
 *
930
 * This hook allows a module to define one or more of its own node types. For
931
 * example, the forum module uses it to define a forum node-type named "Forum
932 933
 * topic." The name and attributes of each desired node type are specified in an
 * array returned by the hook.
934
 *
935 936 937 938 939 940
 * Only module-provided node types should be defined through this hook. User-
 * provided (or 'custom') node types should be defined only in the 'node_type'
 * database table, and should be maintained by using the node_type_save() and
 * node_type_delete() functions.
 *
 * @return
941
 *   An array of information defining the module's node types. The array
942 943 944
 *   contains a sub-array for each node type, with the the machine name of a
 *   content type as the key. Each sub-array has up to 10 attributes.
 *   Possible attributes:
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
 *   - name: (required) The human-readable name of the node type.
 *   - base: (required) The base string used to construct callbacks
 *     corresponding to this node type (for example, if base is defined as
 *     example_foo, then example_foo_insert will be called when inserting a node
 *     of that type). This string is usually the name of the module, but not
 *     always.
 *   - description: (required) A brief description of the node type.
 *   - help: (optional) Help information shown to the user when creating a node
 *     of this type.
 *   - has_title: (optional) A Boolean indicating whether or not this node type
 *     has a title field.
 *   - title_label: (optional) The label for the title field of this content
 *     type.
 *   - locked: (optional) A Boolean indicating whether the administrator can
 *     change the machine name of this type. FALSE = changeable (not locked),
 *     TRUE = unchangeable (locked).
961
 *
962 963 964
 * The machine name of a node type should contain only letters, numbers, and
 * underscores. Underscores will be converted into hyphens for the purpose of
 * constructing URLs.
965 966 967 968 969
 *
 * All attributes of a node type that are defined through this hook (except for
 * 'locked') can be edited by a site administrator. This includes the
 * machine-readable name of a node type, if 'locked' is set to FALSE.
 *
970
 * @ingroup node_api_hooks
971 972 973
 */
function hook_node_info() {
  return array(
974 975 976 977 978
    'forum' => array(
      'name' => t('Forum topic'),
      'base' => 'forum',
      'description' => t('A <em>forum topic</em> starts a new discussion thread within a forum.'),
      'title_label' => t('Subject'),
979 980 981 982
    )
  );
}

983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
/**
 * 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:
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
 *   - 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
1019
 *     0 and 1; be careful not to cast the entire score to an integer by
1020 1021 1022
 *     inadvertently introducing a variable argument.
 *   - arguments: (optional) If any arguments are required for the score, they
 *     can be specified in an array here.
1023 1024
 *
 * @ingroup node_api_hooks
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
 */
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)),
      ),
    );
  }
}


1046
/**
1047
 * Respond to node type creation.
1048
 *
1049 1050
 * This hook is invoked from node_type_save() after the node type is added to
 * the database.
1051 1052
 *
 * @param $info
1053
 *   The node type object that is being created.
1054 1055
 */
function hook_node_type_insert($info) {
1056
  drupal_set_message(t('You have just created a content type with a machine name %type.', array('%type' => $info->type)));
1057 1058
}

1059
/**
1060
 * Respond to node type updates.
1061
 *
1062 1063
 * This hook is invoked from node_type_save() after the node type is updated in
 * the database.
1064 1065
 *
 * @param $info
1066
 *   The node type object that is being updated.
1067
 */
1068 1069 1070 1071 1072
function hook_node_type_update($info) {
  if (!empty($info->old_type) && $info->old_type != $info->type) {
    $setting = variable_get('comment_' . $info->old_type, COMMENT_NODE_OPEN);
    variable_del('comment_' . $info->old_type);
    variable_set('comment_' . $info->type, $setting);
1073 1074 1075
  }
}

1076
/**
1077
 * Respond to node type deletion.
1078
 *
1079 1080
 * This hook is invoked from node_type_delete() after the node type is removed
 * from the database.
1081 1082
 *
 * @param $info
1083
 *   The node type object that is being deleted.
1084 1085 1086 1087 1088
 */
function hook_node_type_delete($info) {
  variable_del('comment_' . $info->type);
}

1089 1090 1091
/**
 * Respond to node deletion.
 *
1092 1093
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_delete() to respond to all node deletions).
1094
 *
1095 1096 1097
 * This hook is invoked from node_delete_multiple() after the node has been
 * removed from the node table in the database, before hook_node_delete() is
 * invoked, and before field_attach_delete() is called.
1098
 *
1099
 * @param \Drupal\Core\Entity\EntityInterface $node
1100
 *   The node that is being deleted.
1101 1102
 *
 * @ingroup node_api_hooks
1103
 */
1104
function hook_delete(\Drupal\Core\Entity\EntityInterface $node) {
1105
  db_delete('mytable')
1106
    ->condition('nid', $node->nid)
1107
    ->execute();
1108 1109 1110
}

/**
1111
 * Act on a node object about to be shown on the add/edit form.
1112
 *
1113 1114
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_prepare() to act on all node preparations).
1115
 *
1116 1117
 * This hook is invoked from NodeFormController::prepareEntity() before the
 * general hook_node_prepare() is invoked.
1118
 *
1119
 * @param \Drupal\Core\Entity\EntityInterface $node
1120
 *   The node that is about to be shown on the add/edit form.
1121 1122
 *
 * @ingroup node_api_hooks
1123
 */
1124
function hook_prepare(\Drupal\Core\Entity\EntityInterface $node) {
1125
  if ($file = file_check_upload($field_name)) {
1126
    $file = file_save_upload($field_name, _image_filename($file->filename, NULL, TRUE), FALSE, 0);
1127
    if ($file) {
1128
      if (!image_get_info($file->uri)) {
1129 1130 1131 1132 1133 1134 1135
        form_set_error($field_name, t('Uploaded file is not a valid image'));
        return;
      }
    }
    else {
      return;
    }
1136
    $node->images['_original'] = $file->uri;
1137
    _image_build_derivatives($node, TRUE);
1138 1139 1140 1141 1142 1143 1144 1145
    $node->new_file = TRUE;
  }
}

/**
 * Display a node editing form.
 *
 * This hook, implemented by node modules, is called to retrieve the form