Changeset 14721

Timestamp:

05/18/2010 05:59:25 AM (14 years ago)

Author:

nacin

Message:

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

Location:

trunk/wp-includes

Files:

• nav-menu-template.php (modified) (1 diff)
• nav-menu.php (modified) (6 diffs)

trunk/wp-includes/nav-menu-template.php

@@ -184 +184 @@
  * 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

trunk/wp-includes/nav-menu.php

@@ -13 +13 @@
  * @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 ) {
@@ -42 +45 @@
  * @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.
  */
@@ -88 +91 @@
     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() {
@@ -469 +484 @@
             $object = get_post_meta( $item->ID, '_menu_item_object', true );
             $type = get_post_meta( $item->ID, '_menu_item_type', true );
-    
+
             if ( 'post_type' == $type )
                 $posts[$object][] = $object_id;
@@ -475 +490 @@
                 $terms[$object][] = $object_id;
         }
-    
+
         if ( !empty($posts) ) {
             foreach ( array_keys($posts) as $post_type ) {
@@ -482 +497 @@
         }
         unset($posts);
-    
+
         if ( !empty($terms) ) {
             foreach ( array_keys($terms) as $taxonomy ) {