hook_access

Define access restrictions.

This hook allows node modules to limit access to the node types they define.

Parameters

$op: The operation to be performed. Possible values:

• "create"
• "delete"
• "update"
• "view"

$node: Either a node object or the machine name of the content type on which to perform the access check.

$account: The user object to perform the access check operation on.

Return value

• TRUE if the operation is to be allowed.
• FALSE if the operation is to be denied.
• NULL to not override the settings in the node_access table, or access control modules.

The administrative account (user ID #1) always passes any access check, so this hook is not called in that case. If this hook is not defined for a node type, all access checks will fail, so only the administrator will be able to see content of that type. However, users with the "administer nodes" permission may always view and edit content through the administrative interface.

For a detailed usage example, see node_example.module.

Related topics

Node access rights

The node access system determines who can do what to which nodes.

Hooks

Allow modules to interact with the Drupal core.

16 functions implement hook_access()

1 invocation of hook_access()

File

developer/hooks/node.php, line 160

These hooks are defined by node modules, modules that define a new kind of node.

Code

function hook_access($op, $node, $account) {
  if ($op == 'create') {
    return user_access('create stories', $account);
  }

  if ($op == 'update' || $op == 'delete') {
    if (user_access('edit own stories', $account) && ($account->uid == $node->uid)) {
      return TRUE;
    }
  }
}