node.api.php 45.3 KB
Newer Older
1
2
3
4
5
6
7
<?php

/**
 * @file
 * Hooks provided by the Node module.
 */

8
9
10
/**
 * @defgroup node_api_hooks Node API Hooks
 * @{
11
 * Functions to define and modify content types.
12
13
14
15
16
17
18
19
20
21
 *
 * Each content type is maintained by a primary module, which is either
 * node.module (for content types created in the user interface) or the
 * module that implements hook_node_info() to define the content type.
 *
 * During node operations (create, update, view, delete, etc.), there are
 * several sets of hooks that get invoked to allow modules to modify the base
 * node operation:
 * - Node-type-specific hooks: These hooks are only invoked on the primary
 *   module, using the "base" return component of hook_node_info() as the
22
23
24
 *   function prefix.  For example, poll.module defines the base for the Poll
 *   content type as "poll", so during creation of a poll node, hook_insert() is
 *   only invoked by calling poll_insert().
25
26
27
 * - 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 example, hook_node_insert() is invoked on all modules when
28
 *   creating a poll node.
29
30
31
32
33
34
35
36
37
38
39
 * - 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:
 * - Creating a new node (calling node_save() on a new node):
 *   - field_attach_presave()
 *   - hook_node_presave() (all)
40
 *   - hook_entity_presave() (all)
41
42
43
44
45
46
47
48
49
50
 *   - 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)
51
 *   - hook_entity_presave() (all)
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 *   - 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)
 * - Loading a node (calling node_load(), node_load_multiple(), or
 *   entity_load() with $entity_type of 'node'):
 *   - 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
 *   node_view() is a loaded node, so the Loading steps above are already
 *   done):
 *   - hook_view() (node-type-specific)
 *   - field_attach_prepare_view()
71
 *   - hook_entity_prepare_view() (all)
72
73
 *   - field_attach_view()
 *   - hook_node_view() (all)
74
75
76
 *   - hook_entity_view() (all)
 *   - hook_node_view_alter() (all)
 *   - hook_entity_view_alter() (all)
77
78
79
80
 * - 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()
81
 *   - hook_entity_prepare_view() (all)
82
83
84
 *   - hook_view() (node-type-specific)
 *   - field_attach_view()
 *   - hook_node_view() (all)
85
 *   - hook_entity_view() (all)
86
 *   - hook_node_view_alter() (all)
87
 *   - hook_entity_view_alter() (all)
88
89
90
91
 * - Deleting a node (calling node_delete() or node_delete_multiple()):
 *   - Node is loaded (see Loading section above)
 *   - hook_delete() (node-type-specific)
 *   - hook_node_delete() (all)
92
 *   - hook_entity_delete() (all)
93
 *   - field_attach_delete()
94
 *   - Node and revision information are deleted from database
95
96
97
98
99
100
101
102
103
 * - 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()
 * - Preparing a node for editing (calling node_form() - note that if it's
 *   an existing node, it will already be loaded; see the Loading section
 *   above):
 *   - hook_prepare() (node-type-specific)
104
 *   - hook_node_prepare() (all)
105
106
107
108
109
110
111
112
113
114
115
116
 *   - 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)
117
 *   - comment_node_update_index() is called.
118
119
120
121
122
123
124
125
 *   - 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)
 * @}
 */

126
127
128
129
130
131
132
133
/**
 * @addtogroup hooks
 * @{
 */

/**
 * Inform the node access system what permissions the user has.
 *
134
135
136
137
 * 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.
138
 *
139
140
141
142
143
 * The realms and grant IDs can be arbitrarily defined by your node access
 * 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.
144
145
 *
 * A node access module may implement as many realms as necessary to
146
147
148
149
 * 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.
150
 *
151
152
153
154
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
 * 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.
 *
 * @see node_access_view_all_nodes()
 * @see node_access_rebuild()
 *
183
 * @param $account
184
185
186
 *   The user object whose grants are requested.
 * @param $op
 *   The node operation to be performed, such as "view", "update", or "delete".
187
 *
188
 * @return
189
190
 *   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.
191
192
193
194
195
196
197
198
199
 *
 * For a detailed example, see node_access_example.module.
 *
 * @ingroup node_access
 */
function hook_node_grants($account, $op) {
  if (user_access('access private content', $account)) {
    $grants['example'] = array(1);
  }
200
  $grants['example_owner'] = array($account->uid);
201
202
203
204
205
206
  return $grants;
}

/**
 * Set permissions for a node to be written to the database.
 *
207
208
209
 * 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
210
211
 * node.
 *
212
213
214
215
216
217
 * 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.
 *
218
219
220
 * Note that the grant values in the return value from your hook must be
 * integers and not boolean TRUE and FALSE.
 *
221
222
223
224
 * 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().
225
 * - 'grant_view': If set to 1 a user that has been identified as a member
226
227
228
 *   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.
229
 * - 'grant_update': If set to 1 a user that has been identified as a member
230
 *   of this gid within this realm can edit this node.
231
 * - 'grant_delete': If set to 1 a user that has been identified as a member
232
233
234
235
236
 *   of this gid within this realm can delete this node.
 * - 'priority': If multiple modules seek to set permissions on a node, the
 *   realms that have the highest priority will win out, and realms with a lower
 *   priority will not be written. If there is any doubt, it is best to
 *   leave this 0.
237
 *
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 *
 * When an implementation is interested in a node but want to deny access to
 * everyone, it may return a "deny all" grant:
 *
 * @code
 * $grants[] = array(
 *   'realm' => 'all',
 *   'gid' => 0,
 *   'grant_view' => 0,
 *   'grant_update' => 0,
 *   'grant_delete' => 0,
 *   'priority' => 1,
 * );
 * @endcode
 *
 * Setting the priority should cancel out other grants. In the case of a
 * conflict between modules, it is safer to use hook_node_access_records_alter()
 * to return only the deny grant.
 *
 * Note: a deny all grant is not written to the database; denies are implicit.
 *
259
 * @see _node_access_write_grants()
260
261
262
263
264
265
266
 *
 * @param $node
 *   The node that has just been saved.
 *
 * @return
 *   An array of grants as defined above.
 *
267
268
 * @ingroup node_access
 */
269
function hook_node_access_records($node) {
270
  // We only care about the node if it has been marked private. If not, it is
271
272
273
  // treated just like any other node and we completely ignore it.
  if ($node->private) {
    $grants = array();
274
275
276
277
278
279
280
281
282
283
284
285
    // Only published nodes should be viewable to all users. If we allow access
    // blindly here, then all users could view an unpublished node.
    if ($node->status) {
      $grants[] = array(
        'realm' => 'example',
        'gid' => 1,
        'grant_view' => 1,
        'grant_update' => 0,
        'grant_delete' => 0,
        'priority' => 0,
      );
    }
286
    // For the example_author array, the GID is equivalent to a UID, which
287
288
289
    // 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.
290
291
292
    $grants[] = array(
      'realm' => 'example_author',
      'gid' => $node->uid,
293
294
295
      'grant_view' => 1,
      'grant_update' => 1,
      'grant_delete' => 1,
296
297
      'priority' => 0,
    );
298

299
300
301
302
    return $grants;
  }
}

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

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

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

403
404
405
/**
 * Add mass node operations.
 *
406
407
408
409
410
 * 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.
411
412
413
414
 *
 * @return
 *   An array of operations. Each operation is an associative array that may
 *   contain the following key-value pairs:
415
416
417
418
419
 *   - 'label': Required. The label for the operation, displayed in the dropdown
 *     menu.
 *   - 'callback': Required. The function to call for the operation.
 *   - 'callback arguments': Optional. An array of additional arguments to pass
 *     to the callback function.
420
421
422
 */
function hook_node_operations() {
  $operations = array(
423
424
425
426
    'publish' => array(
      'label' => t('Publish selected content'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED)),
427
    ),
428
429
430
431
    'unpublish' => array(
      'label' => t('Unpublish selected content'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('status' => NODE_NOT_PUBLISHED)),
432
    ),
433
434
435
436
    '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)),
437
438
    ),
    'demote' => array(
439
440
441
      'label' => t('Demote selected content from front page'),
      'callback' => 'node_mass_update',
      'callback arguments' => array('updates' => array('promote' => NODE_NOT_PROMOTED)),
442
    ),
443
444
445
446
447
448
449
450
451
    '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)),
452
453
    ),
    'delete' => array(
454
455
      'label' => t('Delete selected content'),
      'callback' => NULL,
456
457
458
459
460
    ),
  );
  return $operations;
}

461
/**
462
463
 * Respond to node deletion.
 *
464
465
466
467
 * This hook is invoked from node_delete_multiple() after the type-specific
 * hook_delete() has been invoked, but before hook_entity_delete and
 * field_attach_delete() are called, and before the node is removed from the
 * node table in the database.
468
469
470
 *
 * @param $node
 *   The node that is being deleted.
471
472
 *
 * @ingroup node_api_hooks
473
 */
474
function hook_node_delete($node) {
475
476
477
  db_delete('mytable')
    ->condition('nid', $node->nid)
    ->execute();
478
479
480
}

/**
481
 * Respond to deletion of a node revision.
482
 *
483
484
485
 * 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.
486
487
 *
 * @param $node
488
 *   The node revision (node object) that is being deleted.
489
490
 *
 * @ingroup node_api_hooks
491
 */
492
function hook_node_revision_delete($node) {
493
494
495
  db_delete('mytable')
    ->condition('vid', $node->vid)
    ->execute();
496
497
498
}

/**
499
 * Respond to creation of a new node.
500
 *
501
502
503
 * This hook is invoked from node_save() after the node is inserted into the
 * node table in the database, after the type-specific hook_insert() is invoked,
 * and after field_attach_insert() is called.
504
505
 *
 * @param $node
506
 *   The node that is being created.
507
508
 *
 * @ingroup node_api_hooks
509
 */
510
function hook_node_insert($node) {
511
512
513
514
515
516
  db_insert('mytable')
    ->fields(array(
      'nid' => $node->nid,
      'extra' => $node->extra,
    ))
    ->execute();
517
518
}

519
/**
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
 * Act on nodes being loaded from the database.
 *
 * This hook is invoked during node loading, which is handled by entity_load(),
 * via classes NodeController and DrupalDefaultEntityController. 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_node_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.
 *
 * This hook should only 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.
 *
 * The $types parameter allows for your module to have an early return (for
 * efficiency) if your module only supports 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.
540
541
 *
 * @param $nodes
542
 *   An array of the nodes being loaded, keyed by nid.
543
544
 * @param $types
 *   An array containing the types of the nodes.
545
546
 *
 * For a detailed usage example, see nodeapi_example.module.
547
548
 *
 * @ingroup node_api_hooks
549
 */
550
function hook_node_load($nodes, $types) {
551
  $result = db_query('SELECT nid, foo FROM {mytable} WHERE nid IN(:nids)', array(':nids' => array_keys($nodes)));
552
553
554
555
556
  foreach ($result as $record) {
    $nodes[$record->nid]->foo = $record->foo;
  }
}

557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
/**
 * Control access to a node.
 *
 * 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.
 *
 * 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"
 * permission may always view and edit content through the administrative
 * interface.
 *
 * 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.
 *
573
 * @param object|string $node
574
575
 *   Either a node object or a (machine-readable) content type on which to
 *   perform the access check.
576
 * @param string $op
577
578
579
580
581
 *   The operation to be performed. Possible values:
 *   - "create"
 *   - "delete"
 *   - "update"
 *   - "view"
582
 * @param object $account
583
 *   A user object for which the access check operation is to be performed.
584
 *
585
 * @return integer
586
587
 *   NODE_ACCESS_ALLOW if the operation is to be allowed;
 *   NODE_ACCESS_DENY if the operation is to be denied;
588
 *   NODE_ACCESS_IGNORE to not affect this operation at all.
589
590
 *
 * @ingroup node_access
591
592
 */
function hook_node_access($node, $op, $account) {
593
  $type = is_string($node) ? $node : $node->type;
594

595
  if (in_array($type, node_permissions_get_configured_types())) {
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
    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;
}


618
/**
619
620
621
622
 * Act on a node object about to be shown on the add/edit form.
 *
 * This hook is invoked from node_object_prepare() after the type-specific
 * hook_prepare() is invoked.
623
 *
624
 * @param $node
625
 *   The node that is about to be shown on the add/edit form.
626
627
 *
 * @ingroup node_api_hooks
628
 */
629
function hook_node_prepare($node) {
630
  if (!isset($node->comment)) {
631
    $node->comment = variable_get("comment_$node->type", COMMENT_NODE_OPEN);
632
633
634
635
  }
}

/**
636
 * Act on a node being displayed as a search result.
637
 *
638
 * This hook is invoked from node_search_execute(), after node_load()
639
 * and node_view() have been called.
640
641
 *
 * @param $node
642
643
 *   The node being displayed in a search result.
 *
644
645
646
647
648
649
650
651
 * @return array
 *   Extra information to be displayed with search result. This information
 *   should be presented as an associative array. It will be concatenated
 *   with the post information (last updated, author) in the default search
 *   result theming.
 *
 * @see template_preprocess_search_result()
 * @see search-result.tpl.php
652
653
 *
 * @ingroup node_api_hooks
654
 */
655
function hook_node_search_result($node) {
656
  $comments = db_query('SELECT comment_count FROM {node_comment_statistics} WHERE nid = :nid', array('nid' => $node->nid))->fetchField();
657
  return array('comment' => format_plural($comments, '1 comment', '@count comments'));
658
659
660
}

/**
661
 * Act on a node being inserted or updated.
662
 *
663
664
 * This hook is invoked from node_save() before the node is saved to the
 * database.
665
666
 *
 * @param $node
667
 *   The node that is being inserted or updated.
668
669
 *
 * @ingroup node_api_hooks
670
 */
671
function hook_node_presave($node) {
672
673
674
675
676
677
678
679
680
  if ($node->nid && $node->moderate) {
    // Reset votes when node is updated:
    $node->score = 0;
    $node->users = '';
    $node->votes = 0;
  }
}

/**
681
682
683
684
685
 * Respond to updates to a node.
 *
 * This hook is invoked from node_save() after the node is updated in the node
 * table in the database, after the type-specific hook_update() is invoked, and
 * after field_attach_update() is called.
686
687
 *
 * @param $node
688
 *   The node that is being updated.
689
690
 *
 * @ingroup node_api_hooks
691
 */
692
function hook_node_update($node) {
693
694
695
696
  db_update('mytable')
    ->fields(array('extra' => $node->extra))
    ->condition('nid', $node->nid)
    ->execute();
697
698
699
}

/**
700
 * Act on a node being indexed for searching.
701
 *
702
 * This hook is invoked during search indexing, after node_load(), and after
703
 * the result of node_view() is added as $node->rendered to the node object.
704
705
 *
 * @param $node
706
707
 *   The node being indexed.
 *
708
709
 * @return
 *   Array of additional information to be indexed.
710
711
 *
 * @ingroup node_api_hooks
712
 */
713
function hook_node_update_index($node) {
714
715
716
  $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) {
717
    $text .= '<h2>' . check_plain($comment->subject) . '</h2>' . check_markup($comment->comment, $comment->format, '', TRUE);
718
719
720
721
722
  }
  return $text;
}

/**
723
724
725
726
727
728
 * Perform node validation before a node is created or updated.
 *
 * This hook is invoked from node_validate(), after a user has has 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.
729
 *
730
731
732
733
734
735
 * 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
 * hook_node_presave() instead. If it is really necessary to change
 * the node at the validate stage, you can use form_set_value().
736
737
 *
 * @param $node
738
 *   The node being validated.
739
 * @param $form
740
 *   The form being used to edit the node.
741
742
 * @param $form_state
 *   The form state array.
743
744
 *
 * @ingroup node_api_hooks
745
 */
746
function hook_node_validate($node, $form, &$form_state) {
747
748
749
750
751
752
753
  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.'));
    }
  }
}

754
755
756
757
758
759
760
761
762
763
764
765
/**
 * 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
 * properties. See hook_field_attach_submit() for customizing field-related
 * properties.
 *
 * @param $node
766
 *   The node object being updated in response to a form submission.
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 * @param $form
 *   The form being used to edit the node.
 * @param $form_state
 *   The form state array.
 *
 * @ingroup node_api_hooks
 */
function hook_node_submit($node, $form, &$form_state) {
  // 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']);
  }
}

782
/**
783
 * Act on a node that is being assembled before rendering.
784
 *
785
786
787
788
 * 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().
 *
789
 * When $view_mode is 'rss', modules can also add extra RSS elements and
790
791
 * namespaces to $node->rss_elements and $node->rss_namespaces respectively for
 * the RSS item generated for this node.
792
 * For details on how this is used, see node_feed().
793
 *
794
 * @see forum_node_view()
795
 * @see comment_node_view()
796
797
 *
 * @param $node
798
 *   The node that is being assembled for rendering.
799
800
 * @param $view_mode
 *   The $view_mode parameter from node_view().
801
802
 * @param $langcode
 *   The language code used for rendering.
803
 *
804
805
 * @see hook_entity_view()
 *
806
 * @ingroup node_api_hooks
807
 */
808
function hook_node_view($node, $view_mode, $langcode) {
809
  $node->content['my_additional_field'] = array(
810
    '#markup' => $additional_field,
811
    '#weight' => 10,
812
    '#theme' => 'mymodule_my_additional_field',
813
  );
814
815
}

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

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

846
/**
847
 * Define module-provided node types.
848
 *
849
 * This hook allows a module to define one or more of its own node types. For
850
851
 * example, the forum module uses it to define a forum node-type named "Forum
 * topic." The name and attributes of each desired node type are specified in
852
 * an array returned by the hook.
853
 *
854
855
856
857
858
859
 * 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
860
861
862
863
 *   An array of information defining the module's node types. The array
 *   contains a sub-array for each node type, with the machine-readable type
 *   name as the key. Each sub-array has up to 10 attributes. Possible
 *   attributes:
864
 *   - "name": the human-readable name of the node type. Required.
865
866
867
 *   - "base": the base string used to construct callbacks corresponding to
 *      this node type.
 *      (i.e. if base is defined as example_foo, then example_foo_insert will
868
 *      be called when inserting a node of that type). This string is usually
869
 *      the name of the module, but not always. Required.
870
 *   - "description": a brief description of the node type. Required.
871
872
 *   - "help": help information shown to the user when creating a node of
 *      this type.. Optional (defaults to '').
873
874
875
876
 *   - "has_title": boolean indicating whether or not this node type has a title
 *      field. Optional (defaults to TRUE).
 *   - "title_label": the label for the title field of this content type.
 *      Optional (defaults to 'Title').
877
 *   - "locked": boolean indicating whether the administrator can change the
878
879
 *      machine name of this type. FALSE = changeable (not locked),
 *      TRUE = unchangeable (locked). Optional (defaults to TRUE).
880
881
882
 *
 * The machine-readable name of a node type should contain only letters,
 * numbers, and underscores. Underscores will be converted into hyphens for the
883
 * purpose of constructing URLs.
884
885
886
887
888
 *
 * 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.
 *
889
 * @ingroup node_api_hooks
890
891
892
 */
function hook_node_info() {
  return array(
893
894
895
896
897
    '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'),
898
899
900
901
    )
  );
}

902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
/**
 * 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:
 *   - "title": the human readable name of the ranking mechanism. Required.
 *   - "join": 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. Optional.
 *   - "score": 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
 *     0 and 1; be careful not to cast the entire score to an integer by
939
 *     inadvertently introducing a variable argument. Required.
940
941
 *   - "arguments": if any arguments are required for the score, they can be
 *     specified in an array here.
942
943
 *
 * @ingroup node_api_hooks
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 */
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)),
      ),
    );
  }
}


965
/**
966
 * Respond to node type creation.
967
 *
968
969
 * This hook is invoked from node_type_save() after the node type is added
 * to the database.
970
971
 *
 * @param $info
972
 *   The node type object that is being created.
973
974
975
976
 */
function hook_node_type_insert($info) {
}

977
/**
978
 * Respond to node type updates.
979
 *
980
981
 * This hook is invoked from node_type_save() after the node type is updated
 * in the database.
982
983
 *
 * @param $info
984
 *   The node type object that is being updated.
985
 */
986
987
988
989
990
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);
991
992
993
  }
}

994
/**
995
 * Respond to node type deletion.
996
 *
997
998
 * This hook is invoked from node_type_delete() after the node type is removed
 * from the database.
999
1000
 *
 * @param $info
1001
 *   The node type object that is being deleted.
1002
1003
1004
1005
1006
 */
function hook_node_type_delete($info) {
  variable_del('comment_' . $info->type);
}

1007
1008
1009
/**
 * Respond to node deletion.
 *
1010
1011
 * 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).
1012
 *
1013
1014
1015
 * 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.
1016
 *
1017
1018
 * @param $node
 *   The node that is being deleted.
1019
1020
 *
 * @ingroup node_api_hooks
1021
 */
1022
function hook_delete($node) {
1023
  db_delete('mytable')
1024
    ->condition('nid', $node->nid)
1025
    ->execute();
1026
1027
1028
}

/**
1029
 * Act on a node object about to be shown on the add/edit form.
1030
 *
1031
1032
 * 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).
1033
 *
1034
1035
1036
1037
1038
 * This hook is invoked from node_object_prepare() before the general
 * hook_node_prepare() is invoked.
 *
 * @param $node
 *   The node that is about to be shown on the add/edit form.
1039
1040
 *
 * @ingroup node_api_hooks
1041
 */
1042
function hook_prepare($node) {
1043
1044
1045
  if ($file = file_check_upload($field_name)) {
    $file = file_save_upload($field_name, _image_filename($file->filename, NULL, TRUE));
    if ($file) {
1046
      if (!image_get_info($file->uri)) {
1047
1048
1049
1050
1051
1052
1053
        form_set_error($field_name, t('Uploaded file is not a valid image'));
        return;
      }
    }
    else {
      return;
    }
1054
    $node->images['_original'] = $file->uri;
1055
    _image_build_derivatives($node, TRUE);
1056
1057
1058
1059
1060
1061
1062
1063
    $node->new_file = TRUE;
  }
}

/**
 * Display a node editing form.
 *
 * This hook, implemented by node modules, is called to retrieve the form
1064
1065
1066
1067
1068
1069
1070
1071
1072
 * that is displayed to create or edit a node. This form is displayed at path
 * node/add/[node type] or node/[node ID]/edit.
 *
 * The submit and preview buttons, administrative and display controls, and
 * sections added by other modules (such as path settings, menu settings,
 * comment settings, and fields managed by the Field UI module) are
 * displayed automatically by the node module. This hook just needs to
 * return the node title and form editing fields specific to the node type.
 *
1073
 * @param $node
1074
1075
 *   The node being added or edited.
 * @param $form_state
1076
1077
 *   The form state array.
 *
1078
 * @return
1079
1080
 *   An array containing the title and any custom form elements to be displayed
 *   in the node editing form.
1081
1082
 *
 * @ingroup node_api_hooks
1083
 */
1084
function hook_form($node, &$form_state) {
1085
  $type = node_type_get_type($node);
1086

1087
1088
1089
1090
1091
1092
1093
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => check_plain($type->title_label),
    '#default_value' => !empty($node->title) ? $node->title : '',
    '#required' => TRUE, '#weight' => -5
  );

1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
  $form['field1'] = array(
    '#type' => 'textfield',
    '#title' => t('Custom field'),
    '#default_value' => $node->field1,
    '#maxlength' => 127,
  );
  $form['selectbox'] = array(
    '#type' => 'select',
    '#title' => t('Select box'),
    '#default_value' => $node->selectbox,
    '#options' => array(
      1 => 'Option A',
      2 => 'Option B',
      3 => 'Option C',
    ),
1109
    '#description' => t('Choose an option.'),
1110
1111
1112
1113
1114
1115
  );

  return $form;
}

/**
1116
 * Respond to creation of a new node.
1117
 *
1118
1119
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_insert() to act on all node insertions).
1120
 *
1121
1122
1123
 * This hook is invoked from node_save() after the node is inserted into the
 * node table in the database, before field_attach_insert() is called, and
 * before hook_node_insert() is invoked.
1124
 *
1125
1126
 * @param $node
 *   The node that is being created.
1127
1128
 *
 * @ingroup node_api_hooks
1129
 */
1130
function hook_insert($node) {
1131
1132
1133
1134
1135
1136
  db_insert('mytable')
    ->fields(array(
      'nid' => $node->nid,
      'extra' => $node->extra,
    ))
    ->execute();
1137
1138
1139
}

/**
1140
 * Act on nodes being loaded from the database.
1141
 *
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_load() to respond to all node loads).
 *
 * This hook is invoked during node loading, which is handled by entity_load(),
 * via classes NodeController and DrupalDefaultEntityController. 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_node_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.
 *
 * This hook should only 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.
1158
 *
1159
 * @param $nodes
1160
 *   An array of the nodes being loaded, keyed by nid.
1161
1162
 *
 * For a detailed usage example, see node_example.module.
1163
1164
 *
 * @ingroup node_api_hooks
1165
 */
1166
function hook_load($nodes) {
1167
  $result = db_query('SELECT nid, foo FROM {mytable} WHERE nid IN (:nids)', array(':nids' => array_keys($nodes)));
1168
1169
1170
  foreach ($result as $record) {
    $nodes[$record->nid]->foo = $record->foo;
  }
1171
1172
1173
}

/**
1174
 * Respond to updates to a node.
1175
 *
1176
1177
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_update() to act on all node updates).
1178
 *
1179
1180
1181
 * This hook is invoked from node_save() after the node is updated in the
 * node table in the database, before field_attach_update() is called, and
 * before hook_node_update() is invoked.
1182
 *
1183
1184
 * @param $node
 *   The node that is being updated.
1185
1186
 *
 * @ingroup node_api_hooks
1187
 */
1188
function hook_update($node) {
1189
1190
1191
1192
  db_update('mytable')
    ->fields(array('extra' => $node->extra))
    ->condition('nid', $node->nid)
    ->execute();
1193
1194
1195
}

/**
1196
 * Perform node validation before a node is created or updated.
1197
 *
1198
1199
 * This hook is invoked only on the module that defines the node's content type
 * (use hook_node_validate() to act on all node validations).
1200
 *
1201
 * This hook is invoked from node_validate(), after a user has finished
1202