diff options
author | Jennifer Hodgdon <yahgrp@poplarware.com> | 2013-06-06 09:15:28 -0700 |
---|---|---|
committer | Jennifer Hodgdon <yahgrp@poplarware.com> | 2013-06-06 09:15:28 -0700 |
commit | bb412015ea8b4680713ddca4402ab64447164556 (patch) | |
tree | aa46c14271f7deaeccfa351ee5796b4bea982000 /modules/system | |
parent | 0811215768c48dd3a802c6dc91ca781964fd815f (diff) | |
download | brdo-bb412015ea8b4680713ddca4402ab64447164556.tar.gz brdo-bb412015ea8b4680713ddca4402ab64447164556.tar.bz2 |
Issue #1811520 by JacobSanford, lirantal: Add section tags to theme, hook_menu, and t documentation.
Diffstat (limited to 'modules/system')
-rw-r--r-- | modules/system/system.api.php | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/modules/system/system.api.php b/modules/system/system.api.php index d8b7864e4..77d2b964c 100644 --- a/modules/system/system.api.php +++ b/modules/system/system.api.php @@ -956,6 +956,7 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * paths and whose values are an associative array of properties for each * path. (The complete list of properties is in the return value section below.) * + * @section sec_callback_funcs Callback Functions * The definition for each path may include a page callback function, which is * invoked when the registered path is requested. If there is no other * registered path that fits the requested path better, any further path @@ -980,6 +981,7 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * $jkl will be 'foo'. Note that this automatic passing of optional path * arguments applies only to page and theme callback functions. * + * @subsection sub_callback_arguments Callback Arguments * In addition to optional path arguments, the page callback and other callback * functions may specify argument lists as arrays. These argument lists may * contain both fixed/hard-coded argument values and integers that correspond @@ -1022,6 +1024,8 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * @endcode * See @link form_api Form API documentation @endlink for details. * + * @section sec_path_wildcards Wildcards in Paths + * @subsection sub_simple_wildcards Simple Wildcards * Wildcards within paths also work with integer substitution. For example, * your module could register path 'my-module/%/edit': * @code @@ -1034,6 +1038,7 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * with 'foo' and passed to the callback function. Note that wildcards may not * be used as the first component. * + * @subsection sub_autoload_wildcards Auto-Loader Wildcards * Registered paths may also contain special "auto-loader" wildcard components * in the form of '%mymodule_abc', where the '%' part means that this path * component is a wildcard, and the 'mymodule_abc' part defines the prefix for a @@ -1065,6 +1070,7 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * return FALSE for the path 'node/999/edit' if a node with a node ID of 999 * does not exist. The menu routing system will return a 404 error in this case. * + * @subsection sub_argument_wildcards Argument Wildcards * You can also define a %wildcard_to_arg() function (for the example menu * entry above this would be 'mymodule_abc_to_arg()'). The _to_arg() function * is invoked to retrieve a value that is used in the path in place of the @@ -1089,6 +1095,7 @@ function hook_menu_get_item_alter(&$router_item, $path, $original_map) { * are called when the menu system is generating links to related paths, such * as the tabs for a set of MENU_LOCAL_TASK items. * + * @section sec_render_tabs Rendering Menu Items As Tabs * You can also make groups of menu items to be rendered (by default) as tabs * on a page. To do that, first create one menu item of type MENU_NORMAL_ITEM, * with your chosen path, such as 'foo'. Then duplicate that menu item, using a |