function hook_nodeapi

You are here

4.6 core.php hook_nodeapi(&$node, $op, $teaser = NULL, $page = NULL)
4.7 core.php hook_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL)
5 core.php hook_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL)
6 core.php hook_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL)

Act on nodes defined by other modules.

Despite what its name might make you think, hook_nodeapi() is not reserved for node modules. On the contrary, it allows modules to react to actions affecting all kinds of nodes, regardless of whether that module defined the node.

Parameters

&$node: The node the action is being performed on.

$op: What kind of action is being performed. Possible values:

  • "delete": The node is being deleted.
  • "insert": The node is being created (inserted in the database).
  • "load": The node is about to be loaded from the database. This hook can be used to load additional data at this time.
  • "prepare": The node is about to be shown on the add/edit form.
  • "search result": The node is displayed as a search result. If you want to display extra information with the result, return it.
  • "print": Prepare a node view for printing. Used for printer-friendly view in book_module
  • "update": The node is being updated.
  • "submit": The node passed validation and will soon be saved. Modules may use this to make changes to the node before it is saved to the database.
  • "update index": The node is being indexed. If you want additional information to be indexed which is not already visible through nodeapi "view", then you should return it here.
  • "validate": The user has just finished editing the node and is trying to preview or submit it. This hook can be used to check the node data. Errors should be set with form_set_error().
  • "view": The node is about to be presented to the user. The module may change $node->body prior to presentation. This hook will be called after hook_view(), so the module may assume the node is filtered and now contains HTML.
  • "rss item": An RSS feed is generated. The module can return properties to be added to the RSS item generated for this node. See comment_nodeapi() and upload_nodeapi() for examples. The $node passed can also be modified to add or remove contents to the feed item.

$a3:

  • For "view", passes in the $teaser parameter from node_view().
  • For "validate", passes in the $form parameter from node_validate().

$a4:

  • For "view", passes in the $page parameter from node_view().

Return value

This varies depending on the operation.

  • The "submit", "insert", "update", "delete", "print' and "view" operations have no return value.
  • The "load" operation should return an array containing pairs of fields => values to be merged into the node object.

If you are writing a node module, do not use this hook to perform actions on your type of node alone. Instead, use the hooks set aside for node modules, such as hook_insert() and hook_form().

Related topics

12 functions implement hook_nodeapi()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

book_nodeapi in modules/book.module
Implementation of hook_nodeapi().
comment_nodeapi in modules/comment.module
Implementation of hook_nodeapi().
forum_nodeapi in modules/forum.module
Implementation of hook_nodeapi().
menu_nodeapi in modules/menu.module
Implementation of hook_nodeapi().
nodeapi_example_nodeapi in developer/examples/nodeapi_example.module
Implementation of hook_nodeapi().

... See full list

2 invocations of hook_nodeapi()
node_invoke_nodeapi in modules/node.module
Invoke a hook_nodeapi() operation in all modules.
node_search in modules/node.module
Implementation of hook_search().

File

developer/hooks/core.php, line 728
These are the hooks that are invoked by the Drupal core.

Code

function hook_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
  switch ($op) {
    case 'submit':
      if ($node->nid && $node->moderate) {
        // Reset votes when node is updated:
        $node->score = 0;
        $node->users = '';
        $node->votes = 0;
      }
      break;
    case 'insert':
    case 'update':
      if ($node->moderate && user_access('access submission queue')) {
        drupal_set_message(t('The post is queued for approval'));
      }
      elseif ($node->moderate) {
        drupal_set_message(t('The post is queued for approval. The editors will decide whether it should be published.'));
      }
      break;
  }
}