summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2009-04-27 16:35:05 +0000
committerDries Buytaert <dries@buytaert.net>2009-04-27 16:35:05 +0000
commitc73a93e87024ec5faf11b2305a3cd06c435dd7a4 (patch)
treed6be516c4a5a22fa5dab0151f125add698baa546
parent5349ff1d26d087cd86b6875162cbd97ddaa3fcc7 (diff)
downloadbrdo-c73a93e87024ec5faf11b2305a3cd06c435dd7a4.tar.gz
brdo-c73a93e87024ec5faf11b2305a3cd06c435dd7a4.tar.bz2
- Patch #382834 by cwgordon7: hook_menu API docs missedsome elements.
-rw-r--r--modules/menu/menu.api.php15
1 files changed, 15 insertions, 0 deletions
diff --git a/modules/menu/menu.api.php b/modules/menu/menu.api.php
index d2554ded9..08f97ec3d 100644
--- a/modules/menu/menu.api.php
+++ b/modules/menu/menu.api.php
@@ -41,6 +41,21 @@
* 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. Integer values pass the corresponding URL component.
+ * - "file": A file that will be included before the callbacks are accessed.
+ * this allows callback functions to be in separate files. The file should
+ * be relative to the implementing module's directory unless otherwise
+ * specified by the "file path" option.
+ * - "file path": The path to the folder containing the file specified in
+ * "file". This defaults to the path to the module implementing the hook.
+ * - "load arguments": An array of arguments to be passed to each of the
+ * object loaders in the path. For example, for the router item at
+ * node/%node/revisions/%/view, the array(1, 3) will call node_load() with
+ * the arguments corresponding to the second and fourth url argument;
+ * as with other arguments, integers are automatically cast to url
+ * arguments. There are also two "magic" values: "%index" will correspond
+ * to the url index where the object's load function is specified; "%map"
+ * will correspond to the full menu map, passed in by reference to the
+ * load function.
* - "weight": An integer that determines relative position of items in the
* menu; higher-weighted items sink. Defaults to 0. When in doubt, leave
* this alone; the default alphabetical order is usually best.