golem
/
twentyGOLEM
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Inline docs for menu location functions. props jorbin, see #13378. 

git-svn-id: http://svn.automattic.com/wordpress/trunk@14721 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
nacin 2010-05-18 05:59:25 +00:00
parent 31b71cd5c0
commit 77a67b3fed
2 changed files with 23 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
wp-includes/nav-menu-template.php
View File

@ -183,8 +183,7 @@ class Walker_Nav_Menu_Checklist extends Walker_Nav_Menu {
* depth - how many levels of the hierarchy are to be included. 0 means all. Defaults to 0.
* walker - allows a custom walker to be specified.
* context - the context the menu is used in.
*
* @todo show_home - If you set this argument, then it will display the link to the home page. The show_home argument really just needs to be set to the value of the text of the link.
* theme_location - the location in the theme to be used. Must be registered with register_nav_menu() in order to be selectable by the user.
*
* @since 3.0.0
*

23
wp-includes/nav-menu.php
View File

@ -12,8 +12,11 @@
*
* @since 3.0.0
*
* @param string $menu Menu id
* @return mixed $menu|false Or WP_Error
* @uses get_term
* @uses get_term_by
*
* @param string $menu Menu id, slug or name
* @return mixed false if $menu param isn't supplied or term does not exist, menu object if successfull
*/
function wp_get_nav_menu_object( $menu ) {
if ( ! $menu )
@ -41,7 +44,7 @@ function wp_get_nav_menu_object( $menu ) {
*
* @since 3.0.0
*
* @param int|string $menu The menu to check
* @param int|string $menu The menu to check (id, slug, or name)
* @return bool Whether the menu exists.
*/
function is_nav_menu( $menu ) {
@ -87,11 +90,23 @@ function register_nav_menus( $locations = array() ) {
function register_nav_menu( $location, $description ) {
register_nav_menus( array( $location => $description ) );
}
/**
* Returns an array of all registered nav menus in a theme
*
* @since 3.0.0
* @return array
*/
function get_registered_nav_menus() {
return $GLOBALS['_wp_registered_nav_menus'];
}
/**
* Returns an array with the registered nav menu locations and the menu assigned to it
*
* @since 3.0.0
* @return array
*/
function get_nav_menu_locations() {
return get_theme_mod('nav_menu_locations');
}