summaryrefslogtreecommitdiff
path: root/modules/node
diff options
context:
space:
mode:
authorwebchick <webchick@24967.no-reply.drupal.org>2011-12-24 17:58:33 -0800
committerwebchick <webchick@24967.no-reply.drupal.org>2011-12-24 17:58:33 -0800
commit8259aab1db320597b4a7f16e7ca8697780da4704 (patch)
tree5e95be1ec2321f3ba9085cc6799d6605a25989a2 /modules/node
parent67b7ac08eb8a688f65e104717749f5abd17b9e24 (diff)
downloadbrdo-8259aab1db320597b4a7f16e7ca8697780da4704.tar.gz
brdo-8259aab1db320597b4a7f16e7ca8697780da4704.tar.bz2
Issue #629518 by jhodgdon, reglogge, jvns, oriol_e9g: Fixed hook_node_insert() and other node hooks have imprecise/misleading descriptions.
Diffstat (limited to 'modules/node')
-rw-r--r--modules/node/node.api.php11
1 files changed, 6 insertions, 5 deletions
diff --git a/modules/node/node.api.php b/modules/node/node.api.php
index 7f8e22866..dbc5f3d0b 100644
--- a/modules/node/node.api.php
+++ b/modules/node/node.api.php
@@ -1229,9 +1229,12 @@ function hook_validate($node, $form, &$form_state) {
/**
* Display a node.
*
- * This is a hook used by node modules. It allows a module to define a
- * custom method of displaying its nodes, usually by displaying extra
- * information particular to that node type.
+ * This hook is invoked only on the module that defines the node's content type
+ * (use hook_node_view() to act on all node views).
+ *
+ * This hook is invoked during node viewing after the node is fully loaded,
+ * so that the node type module can define a custom method for display, or
+ * add to the default display.
*
* @param $node
* The node to be displayed, as returned by node_load().
@@ -1249,8 +1252,6 @@ function hook_validate($node, $form, &$form_state) {
* view of the node, you might consider implementing one of these hooks
* instead.
*
- * For a detailed usage example, see node_example.module.
- *
* @ingroup node_api_hooks
*/
function hook_view($node, $view_mode) {