Ticket #13378: 14720.patch

wp-includes/nav-menu-template.php

@@ -183 +183 @@
  * 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.
- * 
+ * theme_location - the location in the theme to be used.  Must be registed with register_nav_menu in order to be selectable by the user
+ *
  * @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.
  *
  * @since 3.0.0

wp-includes/nav-menu.php

@@ -12 +12 @@
  *
  * @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 +44 @@
  *
  * @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 +90 @@
 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
+ *
+ * @retun array
+ */
+
 function get_nav_menu_locations() {
         return get_theme_mod('nav_menu_locations');
 }
@@ -468 +486 @@
                         $object_id = get_post_meta( $item->ID, '_menu_item_object_id', true );
                         $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;
                         elseif ( 'taxonomy' == $type)
                                 $terms[$object][] = $object_id;
                 }
-        
+
                 if ( !empty($posts) ) {
                         foreach ( array_keys($posts) as $post_type ) {
                                 get_posts( array('post__in' => $posts[$post_type], 'post_type' => $post_type, 'nopaging' => true, 'update_post_term_cache' => false) );
                         }
                 }
                 unset($posts);
-        
+
                 if ( !empty($terms) ) {
                         foreach ( array_keys($terms) as $taxonomy ) {
                                 get_terms($taxonomy, array('include' => $terms[$taxonomy]) );