function hook_acl_explain in ACL 6

Same name and namespace in other branches

1. 8 acl.api.php \hook_acl_explain()
2. 7 acl.api.php \hook_acl_explain()

Explain what your ACL grant records mean.

File

./acl.api.php, line 11

API documentation for ACL.

Code

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).";
}