You are here

acl.api.php in ACL 6

Same filename and directory in other branches

API documentation for ACL.

File

acl.api.php

View source

<?php

/**
 * @file
 * API documentation for ACL.
 */

/**
 * Explain what your ACL grant records mean.
 */
function hook_acl_explain($acl_id, $name, $users = NULL) {
  if (empty($users)) {
    return "ACL (id={$acl_id}) would grant access to {$name}.";
  }
  return "ACL (id={$acl_id}) grants access to {$name} to the listed user(s).";
}

Functions

Name	Description
hook_acl_explain	Explain what your ACL grant records mean.