From 31311257b4f24e7708f825ee61169785963092ba Mon Sep 17 00:00:00 2001 From: Bob Vincent Date: Tue, 18 Oct 2011 12:52:23 -0400 Subject: [PATCH] Issue #789484 by hctom, michaellenaham, sven.lauer, Lars Toomre, Mac_Weber: Fix documentation for hook_node_access(). --- modules/node/node.api.php | 17 ++++++++--------- 1 files changed, 8 insertions(+), 9 deletions(-) diff --git a/modules/node/node.api.php b/modules/node/node.api.php index bc2eb65b1733f6a3ec3bcdc471a0d7f522cd6b77..5c41e1f761cd43a259d25ecf2db739c62e871f58 100644 --- a/modules/node/node.api.php +++ b/modules/node/node.api.php @@ -570,11 +570,9 @@ function hook_node_load($nodes, $types) { * block access, return NODE_ACCESS_IGNORE or simply return nothing. * Blindly returning FALSE will break other node access modules. * - * @link http://api.drupal.org/api/group/node_access/7 More on the node access system @endlink - * @ingroup node_access * @param $node - * The node on which the operation is to be performed, or, if it does - * not yet exist, the type of node to be created. + * Either a node object or a (machine-readable) content type on which to + * perform the access check. * @param $op * The operation to be performed. Possible values: * - "create" @@ -582,13 +580,14 @@ function hook_node_load($nodes, $types) { * - "update" * - "view" * @param $account - * A user object representing the user for whom the operation is to be - * performed. + * The user object to perform the access check operation on. * * @return * NODE_ACCESS_ALLOW if the operation is to be allowed; * NODE_ACCESS_DENY if the operation is to be denied; * NODE_ACCESS_IGNORE to not affect this operation at all. + * + * @ingroup node_access */ function hook_node_access($node, $op, $account) { $type = is_string($node) ? $node : $node->type; @@ -880,9 +879,9 @@ function hook_node_view_alter(&$build) { * machine name of this type. FALSE = changeable (not locked), * TRUE = unchangeable (locked). Optional (defaults to TRUE). * - * The machine-readable name of a node type should contain only letters, - * numbers, and underscores. Underscores will be converted into hyphens for the - * purpose of constructing URLs. + * The machine name of a node type should contain only letters, numbers, and + * underscores. Underscores will be converted into hyphens for the purpose of + * constructing URLs. * * 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 -- 1.7.5.4