Commit db9cfa2b authored by webchick's avatar webchick

#629518 by jhodgdon: Improve documentation on hook_node_insert() and other node hooks.

parent 6a891651
......@@ -216,19 +216,20 @@ function hook_node_grants_alter(&$grants, $account, $op) {
/**
* Add mass node operations.
*
* 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.
* 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.
*
* @return
* An array of operations. Each operation is an associative array that may
* contain the following key-value pairs:
* - "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.
*
* - '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.
*/
function hook_node_operations() {
$operations = array(
......@@ -260,7 +261,11 @@ function hook_node_operations() {
}
/**
* Act on node deletion.
* Respond to node deletion.
*
* This hook is invoked from node_delete_multiple() after the node has been
* removed from the node table in the database, after the type-specific
* hook_delete() has been invoked, and before field_attach_delete() is called.
*
* @param $node
* The node that is being deleted.
......@@ -272,12 +277,14 @@ function hook_node_delete($node) {
}
/**
* A revision of the node is deleted.
* Respond to deletion of a node revision.
*
* You can delete data associated with that revision.
* 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.
*
* @param $node
* The node the action is being performed on.
* The node revision (node object) that is being deleted.
*/
function hook_node_revision_delete($node) {
db_delete('upload')->condition('vid', $node->vid)->execute();
......@@ -290,12 +297,14 @@ function hook_node_revision_delete($node) {
}
/**
* Respond to node insertion.
* Respond to creation of a new node.
*
* Take action when a new node of any type is being inserted in the database.
* 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.
*
* @param $node
* The node the action is being performed on.
* The node that is being created.
*/
function hook_node_insert($node) {
db_insert('mytable')
......@@ -369,6 +378,7 @@ function hook_node_load($nodes, $types) {
* @param $account
* A user object representing the user for whom the operation is to be
* performed.
*
* @return
* NODE_ACCESS_ALLOW if the operation is to be allowed;
* NODE_ACCESS_DENY if the operation is to be denied;
......@@ -401,10 +411,13 @@ function hook_node_access($node, $op, $account) {
/**
* The node is about to be shown on the add/edit form.
* 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.
*
* @param $node
* The node the action is being performed on.
* The node that is about to be shown on the add/edit form.
*/
function hook_node_prepare($node) {
if (!isset($node->comment)) {
......@@ -413,24 +426,27 @@ function hook_node_prepare($node) {
}
/**
* The node is being cloned for translation.
* Act on a node object being cloned for translation.
*
* This hook can be used to load additional data or copy values from
* $node->translation_source.
* This hook is invoked from translation_node_prepare() after the node is
* loaded. $node->language is set to the language being requested, and
* $node->translation_source is set to the node object being cloned.
*
* @param $node
* The node the action is being performed on.
* The node object being prepared for translation.
*/
function hook_node_prepare_translation($node) {
}
/**
* The node is being displayed as a search result.
* Act on a node being displayed as a search result.
*
* If you want to display extra information with the result, return it.
* This hook is invoked from node_search_execute(), after node_load()
* and node_build() have been called.
*
* @param $node
* The node the action is being performed on.
* The node being displayed in a search result.
*
* @return
* Extra information to be displayed with search result.
*/
......@@ -440,12 +456,13 @@ function hook_node_search_result($node) {
}
/**
* The node passed validation and is about to be saved.
* Act on a node being inserted or updated.
*
* Modules may make changes to the node before it is saved to the database.
* This hook is invoked from node_save() before the node is saved to the
* database.
*
* @param $node
* The node the action is being performed on.
* The node that is being inserted or updated.
*/
function hook_node_presave($node) {
if ($node->nid && $node->moderate) {
......@@ -457,10 +474,14 @@ function hook_node_presave($node) {
}
/**
* The node being updated.
* 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.
*
* @param $node
* The node the action is being performed on.
* The node that is being updated.
*/
function hook_node_update($node) {
db_update('mytable')
......@@ -470,13 +491,14 @@ function hook_node_update($node) {
}
/**
* The node is being indexed.
* Act on a node being indexed for searching.
*
* If you want additional information to be indexed which is not already
* visible through node "view", then you should return it here.
* This hook is invoked during search indexing, after node_load(), and after
* the result of node_build() is added as $node->rendered to the node object.
*
* @param $node
* The node the action is being performed on.
* The node being indexed.
*
* @return
* Array of additional information to be indexed.
*/
......@@ -490,15 +512,24 @@ function hook_node_update_index($node) {
}
/**
* The user has finished editing the node and is previewing or submitting it.
* 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.
*
* This hook can be used to check the node data. Errors should be set with
* form_set_error().
* 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().
*
* @param $node
* The node the action is being performed on.
* The node being validated.
* @param $form
* The $form parameter from node_validate().
* The form being used to edit the node.
*/
function hook_node_validate($node, $form) {
if (isset($node->end) && isset($node->start)) {
......@@ -509,7 +540,7 @@ function hook_node_validate($node, $form) {
}
/**
* The node content is being assembled before rendering.
* Act on a node that is being assembled before rendering.
*
* TODO D7 This needs work to clearly explain the different build modes.
*
......@@ -527,7 +558,7 @@ function hook_node_validate($node, $form) {
* @see comment_node_view()
*
* @param $node
* The node the action is being performed on.
* The node that is being assembled for rendering.
* @param $build_mode
* The $build_mode parameter from node_build().
*/
......@@ -540,15 +571,15 @@ function hook_node_view($node, $build_mode) {
}
/**
* The node content was built; the module may modify the structured content.
* Alter the results of node_build().
*
* 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.
* 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.
*
* If the module wishes to act on the rendered HTML of the node rather than the
* structured content array, it may use this hook to add a #post_render callback.
* Alternatively, it could also implement hook_preprocess_node(). See
* structured content array, it may use this hook to add a #post_render
* callback. Alternatively, it could also implement hook_preprocess_node(). See
* drupal_render() and theme() documentation respectively for details.
*
* @param $build
......@@ -567,7 +598,7 @@ function hook_node_build_alter($build) {
}
/**
* Defines module-provided node types.
* Define module-provided node types.
*
* This hook allows a module to define one or more of its own node types. For
* example, the blog module uses it to define a blog node-type named "Blog
......@@ -687,23 +718,25 @@ function hook_ranking() {
/**
* Act on node type creation.
* Respond to node type creation.
*
* This hook allows modules to take action when a node type is created.
* This hook is invoked from node_type_save() after the node type is added
* to the database.
*
* @param $info
* The node type object which is being created.
* The node type object that is being created.
*/
function hook_node_type_insert($info) {
}
/**
* Act on node type changes.
* Respond to node type updates.
*
* This hook allows modules to take action when a node type is modified.
* This hook is invoked from node_type_save() after the node type is updated
* in the database.
*
* @param $info
* The node type object which is being modified.
* The node type object that is being updated.
*/
function hook_node_type_update($info) {
if (!empty($info->old_type) && $info->old_type != $info->type) {
......@@ -714,12 +747,13 @@ function hook_node_type_update($info) {
}
/**
* Act on node type deletion.
* Respond to node type deletion.
*
* This hook allows modules to take action when a node type is deleted.
* This hook is invoked from node_type_delete() after the node type is removed
* from the database.
*
* @param $info
* The node type object which is being deleted.
* The node type object that is being deleted.
*/
function hook_node_type_delete($info) {
variable_del('comment_' . $info->type);
......@@ -728,17 +762,15 @@ function hook_node_type_delete($info) {
/**
* Respond to node deletion.
*
* This is a hook used by node modules. It is called to allow the module
* to take action when a node is being deleted from the database by, for
* example, deleting information from related tables.
*
* @param $node
* The node being deleted.
* 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).
*
* To take action when nodes of any type are deleted (not just nodes of
* the type defined by this module), use hook_node() instead.
* 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.
*
* For a detailed usage example, see node_example.module.
* @param $node
* The node that is being deleted.
*/
function hook_delete($node) {
db_delete('mytable')
......@@ -747,13 +779,16 @@ function hook_delete($node) {
}
/**
* This is a hook used by node modules. It is called after load but before the
* node is shown on the add/edit form.
* Act on a node object about to be shown on the add/edit form.
*
* @param $node
* The node being saved.
* 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).
*
* For a usage example, see image.module.
* 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.
*/
function hook_prepare($node) {
if ($file = file_check_upload($field_name)) {
......@@ -831,19 +866,17 @@ function hook_form($node, $form_state) {
}
/**
* Respond to node insertion.
* Respond to creation of a new node.
*
* This is a hook used by node modules. It is called to allow the module
* to take action when a new node is being inserted in the database by,
* for example, inserting information into related tables.
*
* @param $node
* The node being inserted.
* 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).
*
* To take action when nodes of any type are inserted (not just nodes of
* the type(s) defined by this module), use hook_node() instead.
* 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.
*
* For a detailed usage example, see node_example.module.
* @param $node
* The node that is being created.
*/
function hook_insert($node) {
db_insert('mytable')
......@@ -877,19 +910,17 @@ function hook_load($nodes) {
}
/**
* Respond to node updating.
*
* This is a hook used by node modules. It is called to allow the module
* to take action when an edited node is being updated in the database by,
* for example, updating information in related tables.
* Respond to updates to a node.
*
* @param $node
* The node being updated.
* 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).
*
* To take action when nodes of any type are updated (not just nodes of
* the type(s) defined by this module), use hook_node() instead.
* 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.
*
* For a detailed usage example, see node_example.module.
* @param $node
* The node that is being updated.
*/
function hook_update($node) {
db_update('mytable')
......@@ -899,26 +930,27 @@ function hook_update($node) {
}
/**
* Verify a node editing form.
* Perform node validation before a node is created or updated.
*
* This is a hook used by node modules. It is called to allow the module
* to verify that the node is in a format valid to post to the site.
* Errors should be set with form_set_error().
* 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).
*
* @param $node
* The node to be validated.
* @param $form
* The node edit form array.
* 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 before hook_node_validate() is
* invoked.
*
* To validate nodes of all types (not just nodes of the type(s) defined by
* this module), use hook_node() instead.
* To indicate a validation error, use form_set_error().
*
* Changes made to the $node object within a hook_validate() function will
* have no effect. The preferred method to change a node's content is to use
* 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 function form_set_value().
* the node at the validate stage, you can use form_set_value().
*
* For a detailed usage example, see node_example.module.
* @param $node
* The node being validated.
* @param $form
* The form being used to edit the node.
*/
function hook_validate($node, &$form) {
if (isset($node->end) && isset($node->start)) {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment