summaryrefslogtreecommitdiff
path: root/modules/user/user.api.php
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2010-03-31 13:56:59 +0000
committerDries Buytaert <dries@buytaert.net>2010-03-31 13:56:59 +0000
commit17a505d6cb446df308449915ba3a484aa6c1121b (patch)
treed24f570fa2a6dea4ae860e2af7cb71e1999ce18e /modules/user/user.api.php
parent3e10914bc5a04915772fbf1e3432156d34058540 (diff)
downloadbrdo-17a505d6cb446df308449915ba3a484aa6c1121b.tar.gz
brdo-17a505d6cb446df308449915ba3a484aa6c1121b.tar.bz2
- Patch #570430 by jhodgdon: hook_user() and hook_user_categories() doc missing components.
Diffstat (limited to 'modules/user/user.api.php')
-rw-r--r--modules/user/user.api.php10
1 files changed, 8 insertions, 2 deletions
diff --git a/modules/user/user.api.php b/modules/user/user.api.php
index 2200555dd..21a10bf67 100644
--- a/modules/user/user.api.php
+++ b/modules/user/user.api.php
@@ -177,13 +177,19 @@ function hook_user_operations() {
}
/**
- * Retrieve a list of all user setting/information categories.
+ * Retrieve a list of user setting or profile information categories.
*
* @return
- * A linear array of associative arrays. These arrays have keys:
+ * An array of associative arrays. Each inner array has elements:
* - "name": The internal name of the category.
* - "title": The human-readable, localized name of the category.
* - "weight": An integer specifying the category's sort ordering.
+ * - "access callback": Name of the access callback function to use to
+ * determine whether the user can edit the category. Defaults to using
+ * user_edit_access(). See hook_menu() for more information on access
+ * callbacks.
+ * - "access arguments": Arguments for the access callback function. Defaults
+ * to array(1).
*/
function hook_user_categories() {
return array(array(