<?php
/**
- * Navigation Menu template functions
+ * Nav Menu API: Template functions
*
* @package WordPress
* @subpackage Nav_Menus
* @since 3.0.0
*/
-/**
- * Create HTML list of nav menu items.
- *
- * @package WordPress
- * @since 3.0.0
- * @uses Walker
- */
-class Walker_Nav_Menu extends Walker {
- /**
- * @see Walker::$tree_type
- * @since 3.0.0
- * @var string
- */
- var $tree_type = array( 'post_type', 'taxonomy', 'custom' );
-
- /**
- * @see Walker::$db_fields
- * @since 3.0.0
- * @todo Decouple this.
- * @var array
- */
- var $db_fields = array( 'parent' => 'menu_item_parent', 'id' => 'db_id' );
-
- /**
- * @see Walker::start_lvl()
- * @since 3.0.0
- *
- * @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) {
- $indent = str_repeat("\t", $depth);
- $output .= "\n$indent<ul class=\"sub-menu\">\n";
- }
-
- /**
- * @see Walker::end_lvl()
- * @since 3.0.0
- *
- * @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) {
- $indent = str_repeat("\t", $depth);
- $output .= "$indent</ul>\n";
- }
-
- /**
- * @see Walker::start_el()
- * @since 3.0.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param object $item Menu item data object.
- * @param int $depth Depth of menu item. Used for padding.
- * @param int $current_page Menu item ID.
- * @param object $args
- */
- function start_el(&$output, $item, $depth, $args) {
- global $wp_query;
- $indent = ( $depth ) ? str_repeat( "\t", $depth ) : '';
-
- $class_names = $value = '';
-
- $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, $args ) );
- $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 ) . '"' : '';
-
- $output .= $indent . '<li' . $id . $value . $class_names .'>';
-
- $attributes = ! empty( $item->attr_title ) ? ' title="' . esc_attr( $item->attr_title ) .'"' : '';
- $attributes .= ! empty( $item->target ) ? ' target="' . esc_attr( $item->target ) .'"' : '';
- $attributes .= ! empty( $item->xfn ) ? ' rel="' . esc_attr( $item->xfn ) .'"' : '';
- $attributes .= ! empty( $item->url ) ? ' href="' . esc_attr( $item->url ) .'"' : '';
-
- $item_output = $args->before;
- $item_output .= '<a'. $attributes .'>';
- $item_output .= $args->link_before . apply_filters( 'the_title', $item->title, $item->ID ) . $args->link_after;
- $item_output .= '</a>';
- $item_output .= $args->after;
-
- $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
- }
-
- /**
- * @see Walker::end_el()
- * @since 3.0.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param object $item Page data object. Not used.
- * @param int $depth Depth of page. Not Used.
- */
- function end_el(&$output, $item, $depth) {
- $output .= "</li>\n";
- }
-}
+/** Walker_Nav_Menu class */
+require_once ABSPATH . WPINC . '/class-walker-nav-menu.php';
/**
* Displays a navigation menu.
*
- * Optional $args contents:
+ * @since 3.0.0
*
- * 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'. 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.
- * 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.
- * items_wrap - How the list items should be wrapped. Defaults to a ul with an id and class. Uses printf() format with numbered placeholders.
+ * @staticvar array $menu_id_slugs
*
- * @since 3.0.0
+ * @param array $args {
+ * Optional. Array of nav menu arguments.
*
- * @param array $args Arguments
+ * @type string $menu Desired menu. Accepts (matching in order) id, slug, name. Default empty.
+ * @type string $menu_class CSS class to use for the ul element which forms the menu. Default 'menu'.
+ * @type string $menu_id The ID that is applied to the ul element which forms the menu.
+ * Default is the menu slug, incremented.
+ * @type string $container Whether to wrap the ul, and what to wrap it with. Default 'div'.
+ * @type string $container_class Class that is applied to the container. Default 'menu-{menu slug}-container'.
+ * @type string $container_id The ID that is applied to the container. Default empty.
+ * @type callable|bool $fallback_cb If the menu doesn't exists, a callback function will fire.
+ * Default is 'wp_page_menu'. Set to false for no fallback.
+ * @type string $before Text before the link markup. Default empty.
+ * @type string $after Text after the link markup. Default empty.
+ * @type string $link_before Text before the link text. Default empty.
+ * @type string $link_after Text after the link text. Default empty.
+ * @type bool $echo Whether to echo the menu or return it. Default true.
+ * @type int $depth How many levels of the hierarchy are to be included. 0 means all. Default 0.
+ * @type object $walker Instance of a custom walker class. Default empty.
+ * @type string $theme_location Theme location to be used. Must be registered with register_nav_menu()
+ * in order to be selectable by the user.
+ * @type string $items_wrap How the list items should be wrapped. Default is a ul with an id and class.
+ * Uses printf() format with numbered placeholders.
+ * }
+ * @return object|false|void Menu output if $echo is false, false if there are no items or no menu was found.
*/
function wp_nav_menu( $args = array() ) {
static $menu_id_slugs = array();
'depth' => 0, 'walker' => '', 'theme_location' => '' );
$args = wp_parse_args( $args, $defaults );
+ /**
+ * Filters the arguments used to display a navigation menu.
+ *
+ * @since 3.0.0
+ *
+ * @see wp_nav_menu()
+ *
+ * @param array $args Array of wp_nav_menu() arguments.
+ */
$args = apply_filters( 'wp_nav_menu_args', $args );
$args = (object) $args;
+ /**
+ * Filters whether to short-circuit the wp_nav_menu() output.
+ *
+ * Returning a non-null value to the filter will short-circuit
+ * wp_nav_menu(), echoing that value if $args->echo is true,
+ * returning that value otherwise.
+ *
+ * @since 3.9.0
+ *
+ * @see wp_nav_menu()
+ *
+ * @param string|null $output Nav menu output to short-circuit with. Default null.
+ * @param object $args An object containing wp_nav_menu() arguments.
+ */
+ $nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );
+
+ if ( null !== $nav_menu ) {
+ if ( $args->echo ) {
+ echo $nav_menu;
+ return;
+ }
+
+ return $nav_menu;
+ }
+
// Get the nav menu based on the requested menu
$menu = wp_get_nav_menu_object( $args->menu );
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;
}
}
}
+ if ( empty( $args->menu ) ) {
+ $args->menu = $menu;
+ }
+
// 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:
+ * - Fall back (if one was specified), or bail.
+ *
+ * If no menu items were found:
+ * - Fall back, 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 ) )
- && $args->fallback_cb && is_callable( $args->fallback_cb ) )
+ && isset( $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 ) )
return false;
$nav_menu = $items = '';
$show_container = false;
if ( $args->container ) {
+ /**
+ * Filters the list of HTML tags that are valid for use as menu containers.
+ *
+ * @since 3.0.0
+ *
+ * @param array $tags The acceptable HTML tags for use as menu containers.
+ * Default is array containing 'div' and 'nav'.
+ */
$allowed_tags = apply_filters( 'wp_nav_menu_container_allowedtags', array( 'div', 'nav' ) );
- if ( in_array( $args->container, $allowed_tags ) ) {
+ if ( is_string( $args->container ) && in_array( $args->container, $allowed_tags ) ) {
$show_container = true;
$class = $args->container_class ? ' class="' . esc_attr( $args->container_class ) . '"' : ' class="menu-'. $menu->slug .'-container"';
$id = $args->container_id ? ' id="' . esc_attr( $args->container_id ) . '"' : '';
// Set up the $menu_item variables
_wp_menu_item_classes_by_context( $menu_items );
- $sorted_menu_items = array();
- foreach ( (array) $menu_items as $key => $menu_item )
- $sorted_menu_items[$menu_item->menu_order] = $menu_item;
+ $sorted_menu_items = $menu_items_with_children = array();
+ foreach ( (array) $menu_items as $menu_item ) {
+ $sorted_menu_items[ $menu_item->menu_order ] = $menu_item;
+ if ( $menu_item->menu_item_parent )
+ $menu_items_with_children[ $menu_item->menu_item_parent ] = true;
+ }
- unset($menu_items);
+ // Add the menu-item-has-children class where applicable
+ if ( $menu_items_with_children ) {
+ foreach ( $sorted_menu_items as &$menu_item ) {
+ if ( isset( $menu_items_with_children[ $menu_item->ID ] ) )
+ $menu_item->classes[] = 'menu-item-has-children';
+ }
+ }
+ unset( $menu_items, $menu_item );
+
+ /**
+ * Filters the sorted list of menu item objects before generating the menu's HTML.
+ *
+ * @since 3.1.0
+ *
+ * @param array $sorted_menu_items The menu items, sorted by each menu item's menu order.
+ * @param object $args An object containing wp_nav_menu() arguments.
+ */
$sorted_menu_items = apply_filters( 'wp_nav_menu_objects', $sorted_menu_items, $args );
$items .= walk_nav_menu_tree( $sorted_menu_items, $args->depth, $args );
$wrap_class = $args->menu_class ? $args->menu_class : '';
- // Allow plugins to hook into the menu to add their own <li>'s
+ /**
+ * Filters the HTML list content for navigation menus.
+ *
+ * @since 3.0.0
+ *
+ * @see wp_nav_menu()
+ *
+ * @param string $items The HTML list content for the menu items.
+ * @param object $args An object containing wp_nav_menu() arguments.
+ */
$items = apply_filters( 'wp_nav_menu_items', $items, $args );
+ /**
+ * Filters the HTML list content for a specific navigation menu.
+ *
+ * @since 3.0.0
+ *
+ * @see wp_nav_menu()
+ *
+ * @param string $items The HTML list content for the menu items.
+ * @param object $args An object containing wp_nav_menu() arguments.
+ */
$items = apply_filters( "wp_nav_menu_{$menu->slug}_items", $items, $args );
+ // Don't print any markup if there are no items at this point.
+ if ( empty( $items ) )
+ return false;
+
$nav_menu .= sprintf( $args->items_wrap, esc_attr( $wrap_id ), esc_attr( $wrap_class ), $items );
unset( $items );
if ( $show_container )
$nav_menu .= '</' . $args->container . '>';
+ /**
+ * Filters the HTML content for navigation menus.
+ *
+ * @since 3.0.0
+ *
+ * @see wp_nav_menu()
+ *
+ * @param string $nav_menu The HTML content for the navigation menu.
+ * @param object $args An object containing wp_nav_menu() arguments.
+ */
$nav_menu = apply_filters( 'wp_nav_menu', $nav_menu, $args );
if ( $args->echo )
* Add the class property classes for the current context, if applicable.
*
* @access private
- * @since 3.0
+ * @since 3.0.0
+ *
+ * @global WP_Query $wp_query
+ * @global WP_Rewrite $wp_rewrite
*
* @param array $menu_items The current menu item objects to which to add the class property information.
*/
function _wp_menu_item_classes_by_context( &$menu_items ) {
- global $wp_query;
+ global $wp_query, $wp_rewrite;
$queried_object = $wp_query->get_queried_object();
$queried_object_id = (int) $wp_query->queried_object_id;
}
}
}
- } 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();
(
( ! 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';
$active_parent_object_ids[] = (int) $menu_item->post_parent;
$active_object = $menu_item->object;
+ // if the menu item corresponds to the currently-queried post type archive
+ } elseif (
+ 'post_type_archive' == $menu_item->type &&
+ is_post_type_archive( array( $menu_item->object ) )
+ ) {
+ $classes[] = 'current-menu-item';
+ $menu_items[$key]->current = true;
// if the menu item corresponds to the currently-requested URL
- } elseif ( 'custom' == $menu_item->object ) {
- $current_url = untrailingslashit( ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
- $item_url = untrailingslashit( strpos( $menu_item->url, '#' ) ? substr( $menu_item->url, 0, strpos( $menu_item->url, '#' ) ) : $menu_item->url );
- $_indexless_current = untrailingslashit( preg_replace( '/index.php$/', '', $current_url ) );
-
- if ( in_array( $item_url, array( $current_url, $_indexless_current ) ) ) {
+ } elseif ( 'custom' == $menu_item->object && isset( $_SERVER['HTTP_HOST'] ) ) {
+ $_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 = set_url_scheme( untrailingslashit( $raw_item_url ) );
+ $_indexless_current = untrailingslashit( preg_replace( '/' . preg_quote( $wp_rewrite->index, '/' ) . '$/', '', $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;
*
* @uses Walker_Nav_Menu to create HTML list content.
* @since 3.0.0
- * @see Walker::walk() for parameters and return description.
+ *
+ * @param array $items
+ * @param int $depth
+ * @param object $r
+ * @return string
*/
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 );
}
/**
*
* @since 3.0.1
* @access private
+ *
+ * @staticvar array $used_ids
+ * @param string $id
+ * @param object $item
+ * @return string
*/
function _nav_menu_item_id_use_once( $id, $item ) {
static $_used_ids = array();
- if ( in_array( $item->ID, $_used_ids ) )
+ if ( in_array( $item->ID, $_used_ids ) ) {
return '';
+ }
$_used_ids[] = $item->ID;
return $id;
}
-add_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once', 10, 2 );
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff