Wordpress 3.5
[autoinstalls/wordpress.git] / wp-includes / nav-menu-template.php
index b9c058708d4a47e512bca2ce90545b58715f073e..df5612d225153218a67ea374f2c2328cf01c394d 100644 (file)
@@ -37,7 +37,7 @@ class Walker_Nav_Menu extends Walker {
         * @param string $output Passed by reference. Used to append additional content.
         * @param int $depth Depth of page. Used for padding.
         */
-       function start_lvl(&$output, $depth) {
+       function start_lvl( &$output, $depth = 0, $args = array() ) {
                $indent = str_repeat("\t", $depth);
                $output .= "\n$indent<ul class=\"sub-menu\">\n";
        }
@@ -49,7 +49,7 @@ class Walker_Nav_Menu extends Walker {
         * @param string $output Passed by reference. Used to append additional content.
         * @param int $depth Depth of page. Used for padding.
         */
-       function end_lvl(&$output, $depth) {
+       function end_lvl( &$output, $depth = 0, $args = array() ) {
                $indent = str_repeat("\t", $depth);
                $output .= "$indent</ul>\n";
        }
@@ -64,8 +64,7 @@ class Walker_Nav_Menu extends Walker {
         * @param int $current_page Menu item ID.
         * @param object $args
         */
-       function start_el(&$output, $item, $depth, $args) {
-               global $wp_query;
+       function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
                $indent = ( $depth ) ? str_repeat( "\t", $depth ) : '';
 
                $class_names = $value = '';
@@ -73,11 +72,11 @@ class Walker_Nav_Menu extends Walker {
                $classes = empty( $item->classes ) ? array() : (array) $item->classes;
                $classes[] = 'menu-item-' . $item->ID;
 
-               $class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item ) );
-               $class_names = ' class="' . esc_attr( $class_names ) . '"';
+               $class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args ) );
+               $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : '';
 
                $id = apply_filters( 'nav_menu_item_id', 'menu-item-'. $item->ID, $item, $args );
-               $id = strlen( $id ) ? ' id="' . esc_attr( $id ) . '"' : '';
+               $id = $id ? ' id="' . esc_attr( $id ) . '"' : '';
 
                $output .= $indent . '<li' . $id . $value . $class_names .'>';
 
@@ -103,7 +102,7 @@ class Walker_Nav_Menu extends Walker {
         * @param object $item Page data object. Not used.
         * @param int $depth Depth of page. Not Used.
         */
-       function end_el(&$output, $item, $depth) {
+       function end_el( &$output, $item, $depth = 0, $args = array() ) {
                $output .= "</li>\n";
        }
 }
@@ -113,21 +112,22 @@ class Walker_Nav_Menu extends Walker {
  *
  * Optional $args contents:
  *
- * menu - The menu that is desired.  Accepts (matching in order) id, slug, name. Defaults to blank.
+ * menu - The menu that is desired. Accepts (matching in order) id, slug, name. Defaults to blank.
  * menu_class - CSS class to use for the ul element which forms the menu. Defaults to 'menu'.
  * menu_id - The ID that is applied to the ul element which forms the menu. Defaults to the menu slug, incremented.
  * container - Whether to wrap the ul, and what to wrap it with. Defaults to 'div'.
  * container_class - the class that is applied to the container. Defaults to 'menu-{menu slug}-container'.
  * container_id - The ID that is applied to the container. Defaults to blank.
- * fallback_cb - If the menu doesn't exists, a callback function will fire. Defaults to 'wp_page_menu'.
+ * fallback_cb - If the menu doesn't exists, a callback function will fire. Defaults to 'wp_page_menu'. Set to false for no fallback.
  * before - Text before the link text.
  * after - Text after the link text.
  * link_before - Text before the link.
  * link_after - Text after the link.
  * echo - Whether to echo the menu or return it. Defaults to echo.
- * depth - how many levels of the hierarchy are to be included.  0 means all.  Defaults to 0.
+ * 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.
- * 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.
+ * 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.
+ * items_wrap - How the list items should be wrapped. Defaults to a ul with an id and class. Uses printf() format with numbered placeholders.
  *
  * @since 3.0.0
  *
@@ -137,7 +137,7 @@ function wp_nav_menu( $args = array() ) {
        static $menu_id_slugs = array();
 
        $defaults = array( 'menu' => '', 'container' => 'div', 'container_class' => '', 'container_id' => '', 'menu_class' => 'menu', 'menu_id' => '',
-       'echo' => true, 'fallback_cb' => 'wp_page_menu', 'before' => '', 'after' => '', 'link_before' => '', 'link_after' => '',
+       'echo' => true, 'fallback_cb' => 'wp_page_menu', 'before' => '', 'after' => '', 'link_before' => '', 'link_after' => '', 'items_wrap' => '<ul id="%1$s" class="%2$s">%3$s</ul>',
        'depth' => 0, 'walker' => '', 'theme_location' => '' );
 
        $args = wp_parse_args( $args, $defaults );
@@ -155,7 +155,7 @@ function wp_nav_menu( $args = array() ) {
        if ( ! $menu && !$args->theme_location ) {
                $menus = wp_get_nav_menus();
                foreach ( $menus as $menu_maybe ) {
-                       if ( $menu_items = wp_get_nav_menu_items($menu_maybe->term_id) ) {
+                       if ( $menu_items = wp_get_nav_menu_items( $menu_maybe->term_id, array( 'update_post_term_cache' => false ) ) ) {
                                $menu = $menu_maybe;
                                break;
                        }
@@ -164,15 +164,21 @@ function wp_nav_menu( $args = array() ) {
 
        // If the menu exists, get its items.
        if ( $menu && ! is_wp_error($menu) && !isset($menu_items) )
-               $menu_items = wp_get_nav_menu_items( $menu->term_id );
+               $menu_items = wp_get_nav_menu_items( $menu->term_id, array( 'update_post_term_cache' => false ) );
 
-       // If no menu was found or if the menu has no items and no location was requested, call the fallback_cb if it exists
+       /*
+        * If no menu was found:
+        *  - Fallback (if one was specified), or bail.
+        *
+        * If no menu items were found:
+        *  - Fallback, but only if no theme location was specified.
+        *  - Otherwise, bail.
+        */
        if ( ( !$menu || is_wp_error($menu) || ( isset($menu_items) && empty($menu_items) && !$args->theme_location ) )
-               && ( function_exists($args->fallback_cb) || is_callable( $args->fallback_cb ) ) )
+               && $args->fallback_cb && is_callable( $args->fallback_cb ) )
                        return call_user_func( $args->fallback_cb, (array) $args );
 
-       // If no fallback function was specified and the menu doesn't exists, bail.
-       if ( !$menu || is_wp_error($menu) )
+       if ( !$menu || is_wp_error( $menu ) || empty( $menu_items ) )
                return false;
 
        $nav_menu = $items = '';
@@ -197,34 +203,33 @@ function wp_nav_menu( $args = array() ) {
 
        unset($menu_items);
 
+       $sorted_menu_items = apply_filters( 'wp_nav_menu_objects', $sorted_menu_items, $args );
+
        $items .= walk_nav_menu_tree( $sorted_menu_items, $args->depth, $args );
        unset($sorted_menu_items);
 
        // Attributes
        if ( ! empty( $args->menu_id ) ) {
-               $slug = $args->menu_id;
+               $wrap_id = $args->menu_id;
        } else {
-               $slug = 'menu-' . $menu->slug;
-               while ( in_array( $slug, $menu_id_slugs ) ) {
-                       if ( preg_match( '#-(\d+)$#', $slug, $matches ) )
-                               $slug = preg_replace('#-(\d+)$#', '-' . ++$matches[1], $slug);
+               $wrap_id = 'menu-' . $menu->slug;
+               while ( in_array( $wrap_id, $menu_id_slugs ) ) {
+                       if ( preg_match( '#-(\d+)$#', $wrap_id, $matches ) )
+                               $wrap_id = preg_replace('#-(\d+)$#', '-' . ++$matches[1], $wrap_id );
                        else
-                               $slug = $slug . '-1';
+                               $wrap_id = $wrap_id . '-1';
                }
        }
-       $menu_id_slugs[] = $slug;
-       $attributes = ' id="' . $slug . '"';
-       $attributes .= $args->menu_class ? ' class="'. $args->menu_class .'"' : '';
+       $menu_id_slugs[] = $wrap_id;
 
-       $nav_menu .= '<ul'. $attributes .'>';
+       $wrap_class = $args->menu_class ? $args->menu_class : '';
 
        // Allow plugins to hook into the menu to add their own <li>'s
        $items = apply_filters( 'wp_nav_menu_items', $items, $args );
        $items = apply_filters( "wp_nav_menu_{$menu->slug}_items", $items, $args );
-       $nav_menu .= $items;
-       unset($items);
 
-       $nav_menu .= '</ul>';
+       $nav_menu .= sprintf( $args->items_wrap, esc_attr( $wrap_id ), esc_attr( $wrap_class ), $items );
+       unset( $items );
 
        if ( $show_container )
                $nav_menu .= '</' . $args->container . '>';
@@ -287,8 +292,6 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
                                }
                        }
                }
-       } elseif ( ! empty( $queried_object->post_type ) && is_post_type_hierarchical( $queried_object->post_type ) ) {
-               _get_post_ancestors( $queried_object );
        } elseif ( ! empty( $queried_object->taxonomy ) && is_taxonomy_hierarchical( $queried_object->taxonomy ) ) {
                $term_hierarchy = _get_term_hierarchy( $queried_object->taxonomy );
                $term_to_ancestor = array();
@@ -311,10 +314,16 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
 
        $possible_object_parents = array_filter( $possible_object_parents );
 
+       $front_page_url = home_url();
+
        foreach ( (array) $menu_items as $key => $menu_item ) {
+
+               $menu_items[$key]->current = false;
+
                $classes = (array) $menu_item->classes;
                $classes[] = 'menu-item';
                $classes[] = 'menu-item-type-' . $menu_item->type;
+               $classes[] = 'menu-item-object-' . $menu_item->object;
 
                // if the menu item corresponds to a taxonomy term for the currently-queried non-hierarchical post object
                if ( $wp_query->is_singular && 'taxonomy' == $menu_item->type && in_array( $menu_item->object_id, $possible_object_parents ) ) {
@@ -328,10 +337,11 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
                        (
                                ( ! empty( $home_page_id ) && 'post_type' == $menu_item->type && $wp_query->is_home && $home_page_id == $menu_item->object_id ) ||
                                ( 'post_type' == $menu_item->type && $wp_query->is_singular ) ||
-                               ( 'taxonomy' == $menu_item->type && ( $wp_query->is_category || $wp_query->is_tag || $wp_query->is_tax ) )
+                               ( 'taxonomy' == $menu_item->type && ( $wp_query->is_category || $wp_query->is_tag || $wp_query->is_tax ) && $queried_object->taxonomy == $menu_item->object )
                        )
                ) {
                        $classes[] = 'current-menu-item';
+                       $menu_items[$key]->current = true;
                        $_anc_id = (int) $menu_item->db_id;
 
                        while(
@@ -353,12 +363,15 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
 
                // if the menu item corresponds to the currently-requested URL
                } elseif ( 'custom' == $menu_item->object ) {
-                       $current_url = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
-                       $item_url = strpos( $menu_item->url, '#' ) ? substr( $menu_item->url, 0, strpos( $menu_item->url, '#' ) ) : $menu_item->url;
-                       $_indexless_current = preg_replace( '/index.php$/', '', $current_url );
-                       
-                       if ( in_array( $item_url, array( $current_url, $_indexless_current ) ) ) {
+                       $_root_relative_current = untrailingslashit( $_SERVER['REQUEST_URI'] );
+                       $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_root_relative_current );
+                       $raw_item_url = strpos( $menu_item->url, '#' ) ? substr( $menu_item->url, 0, strpos( $menu_item->url, '#' ) ) : $menu_item->url;
+                       $item_url = untrailingslashit( $raw_item_url );
+                       $_indexless_current = untrailingslashit( preg_replace( '/index.php$/', '', $current_url ) );
+
+                       if ( $raw_item_url && in_array( $item_url, array( $current_url, $_indexless_current, $_root_relative_current ) ) ) {
                                $classes[] = 'current-menu-item';
+                               $menu_items[$key]->current = true;
                                $_anc_id = (int) $menu_item->db_id;
 
                                while(
@@ -369,14 +382,18 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
                                }
 
                                if ( in_array( home_url(), array( untrailingslashit( $current_url ), untrailingslashit( $_indexless_current ) ) ) ) {
-                                       // Back compat for home limk to match wp_page_menu()
+                                       // Back compat for home link to match wp_page_menu()
                                        $classes[] = 'current_page_item';
                                }
                                $active_parent_item_ids[] = (int) $menu_item->menu_item_parent;
                                $active_parent_object_ids[] = (int) $menu_item->post_parent;
                                $active_object = $menu_item->object;
+
+                       // give front page item current-menu-item class when extra query arguments involved
+                       } elseif ( $item_url == $front_page_url && is_front_page() ) {
+                               $classes[] = 'current-menu-item';
                        }
-                       
+
                        if ( untrailingslashit($item_url) == home_url() )
                                $classes[] = 'menu-item-home';
                }
@@ -394,6 +411,8 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
        // set parent's class
        foreach ( (array) $menu_items as $key => $parent_item ) {
                $classes = (array) $parent_item->classes;
+               $menu_items[$key]->current_item_ancestor = false;
+               $menu_items[$key]->current_item_parent = false;
 
                if (
                        isset( $parent_item->type ) &&
@@ -403,14 +422,19 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
                                        'post_type' == $parent_item->type &&
                                        ! empty( $queried_object->post_type ) &&
                                        is_post_type_hierarchical( $queried_object->post_type ) &&
-                                       in_array( $parent_item->object_id, $queried_object->ancestors )
+                                       in_array( $parent_item->object_id, $queried_object->ancestors ) &&
+                                       $parent_item->object != $queried_object->ID
                                ) ||
 
                                // ancestral term
                                (
                                        'taxonomy' == $parent_item->type &&
                                        isset( $possible_taxonomy_ancestors[ $parent_item->object ] ) &&
-                                       in_array( $parent_item->object_id, $possible_taxonomy_ancestors[ $parent_item->object ] )
+                                       in_array( $parent_item->object_id, $possible_taxonomy_ancestors[ $parent_item->object ] ) &&
+                                       (
+                                               ! isset( $queried_object->term_id ) ||
+                                               $parent_item->object_id != $queried_object->term_id
+                                       )
                                )
                        )
                ) {
@@ -419,9 +443,12 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
 
                if ( in_array(  intval( $parent_item->db_id ), $active_ancestor_item_ids ) ) {
                        $classes[] = 'current-menu-ancestor';
+                       $menu_items[$key]->current_item_ancestor = true;
                }
-               if ( in_array( $parent_item->db_id, $active_parent_item_ids ) )
+               if ( in_array( $parent_item->db_id, $active_parent_item_ids ) ) {
                        $classes[] = 'current-menu-parent';
+                       $menu_items[$key]->current_item_parent = true;
+               }
                if ( in_array( $parent_item->object_id, $active_parent_object_ids ) )
                        $classes[] = 'current-' . $active_object . '-parent';
 
@@ -448,7 +475,7 @@ function walk_nav_menu_tree( $items, $depth, $r ) {
        $walker = ( empty($r->walker) ) ? new Walker_Nav_Menu : $r->walker;
        $args = array( $items, $depth, $r );
 
-       return call_user_func_array( array(&$walker, 'walk'), $args );
+       return call_user_func_array( array($walker, 'walk'), $args );
 }
 
 /**
@@ -465,5 +492,3 @@ function _nav_menu_item_id_use_once( $id, $item ) {
        return $id;
 }
 add_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once', 10, 2 );
-
-?>