summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2010-10-27 19:11:53 +0000
committerDries Buytaert <dries@buytaert.net>2010-10-27 19:11:53 +0000
commita6cb5bbf85186dec88f6c61f1dd9119e24a308e6 (patch)
tree1384b464d4c8cb3ca5bf3fcc7c095db1c8898f09 /modules
parent028fe64eae3a034ac768d28f97c2053e655d84dc (diff)
downloadbrdo-a6cb5bbf85186dec88f6c61f1dd9119e24a308e6.tar.gz
brdo-a6cb5bbf85186dec88f6c61f1dd9119e24a308e6.tar.bz2
- Patch #337909 by chillin411: hook_menu() 'access callback' docs should mention boolean values work too and minor doxygen correction.
Diffstat (limited to 'modules')
-rw-r--r--modules/system/system.api.php10
1 files changed, 6 insertions, 4 deletions
diff --git a/modules/system/system.api.php b/modules/system/system.api.php
index 0275eb859..262f53757 100644
--- a/modules/system/system.api.php
+++ b/modules/system/system.api.php
@@ -1002,12 +1002,14 @@ function hook_page_build(&$page) {
* item. Note that this function is called even if the access checks fail,
* so any custom delivery callback function should take that into account.
* See drupal_deliver_html_page() for an example.
- * - "access callback": A function returning a boolean value that determines
- * whether the user has access rights to this menu item. Defaults to
- * user_access() unless a value is inherited from a parent menu item.
+ * - "access callback": A function returning TRUE if the user has access
+ * rights to this menu item, and FALSE if not. It can also be a boolean
+ * constant instead of a function, and you can also use numeric values
+ * (will be cast to boolean). Defaults to user_access() unless a value is
+ * inherited from a parent menu item.
* - "access arguments": An array of arguments to pass to the access callback
* function, with path component substitution as described above.
- * - "theme callback": Optional. A function returning the machine-readable
+ * - "theme callback": (optional) A function returning the machine-readable
* name of the default theme that will be used to render the page. If this
* function is provided, it is expected to return a currently-active theme
* on the site (otherwise, the main site theme will be used instead). If no