function node_access_needs_rebuild

7.x node.module node_access_needs_rebuild($rebuild = NULL)
6.x node.module node_access_needs_rebuild($rebuild = NULL)
8.x node.module node_access_needs_rebuild($rebuild = NULL)

Flags or unflags the node access grants for rebuilding.

If the argument isn't specified, the current value of the flag is returned. When the flag is set, a message is displayed to users with 'access administration pages' permission, pointing to the 'rebuild' confirm form. This can be used as an alternative to direct node_access_rebuild calls, allowing administrators to decide when they want to perform the actual (possibly time consuming) rebuild. When unsure if the current user is an administrator, node_access_rebuild() should be used instead.

Parameters

$rebuild: (Optional) The boolean value to be written.

Return value

The current value of the flag if no value was provided for $rebuild.

See also

node_access_rebuild()

Related topics

5 calls to node_access_needs_rebuild()
module_disable in drupal/includes/module.inc
Disables a given set of modules.
node_access_rebuild in drupal/modules/node/node.module
Rebuilds the node access database.
node_help in drupal/modules/node/node.module
Implements hook_help().
node_modules_enabled in drupal/modules/node/node.module
Implements hook_modules_enabled().
_node_access_rebuild_batch_finished in drupal/modules/node/node.module
Performs post-processing for node_access_rebuild().

File

drupal/modules/node/node.module, line 3587
The core that allows content to be submitted to the site. Modules and scripts may programmatically submit nodes using the usual form API pattern.

Code

function node_access_needs_rebuild($rebuild = NULL) {
  if (!isset($rebuild)) {
    return variable_get('node_access_needs_rebuild', FALSE);
  }
  elseif ($rebuild) {
    variable_set('node_access_needs_rebuild', TRUE);
  }
  else {
    variable_del('node_access_needs_rebuild');
  }
}