Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #1186886 by Albert Volkman, Mile23: Add detail and better example to hook_node_load docs

8.0.x
Jennifer Hodgdon 2012-09-19 06:25:24 -07:00
parent 8643c01260
commit b019bf1cc9
1 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
core/modules/node/node.api.php
View File

@ -528,42 +528,45 @@ function hook_node_insert(Drupal\node\Node $node) {
}
/**
* Act on nodes being loaded from the database.
* Act on arbitrary nodes being loaded from the database.
*
* This hook is invoked during node loading, which is handled by entity_load(),
* via classes NodeController 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_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
* 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.
*
* 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.
* This hook is invoked during node loading, which is handled by entity_load(),
* via classes NodeController 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.
*
* @param $nodes
* An array of the nodes being loaded, keyed by nid.
* @param $types
* An array containing the types of the nodes.
* 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.
*
* For a detailed usage example, see nodeapi_example.module.
*
* @ingroup node_api_hooks
*/
function hook_node_load($nodes, $types) {
// 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;
}
}
}
/**
* Controls access to a node.