X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/58f607a1de715c9bca69340a4d6fb9e1b9c2bed2..607b7e02d77e7326161e8ec15639052d2040f745:/wp-includes/nav-menu-template.php
diff --git a/wp-includes/nav-menu-template.php b/wp-includes/nav-menu-template.php
index b9c05870..62a66d39 100644
--- a/wp-includes/nav-menu-template.php
+++ b/wp-includes/nav-menu-template.php
@@ -1,148 +1,92 @@
'menu_item_parent', 'id' => 'db_id' );
+ $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' => '', 'items_wrap' => '
',
+ 'depth' => 0, 'walker' => '', 'theme_location' => '' );
+ $args = wp_parse_args( $args, $defaults );
/**
- * @see Walker::start_lvl()
- * @since 3.0.0
+ * Filters the arguments used to display a navigation menu.
*
- * @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\n";
- }
-
- /**
- * @see Walker::start_el()
- * @since 3.0.0
+ * @see wp_nav_menu()
*
- * @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
+ * @param array $args Array of wp_nav_menu() arguments.
*/
- 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 ) );
- $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 . '';
-
- $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 .= '';
- $item_output .= $args->link_before . apply_filters( 'the_title', $item->title, $item->ID ) . $args->link_after;
- $item_output .= '';
- $item_output .= $args->after;
-
- $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
- }
+ $args = apply_filters( 'wp_nav_menu_args', $args );
+ $args = (object) $args;
/**
- * @see Walker::end_el()
- * @since 3.0.0
+ * 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 $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.
+ * @param string|null $output Nav menu output to short-circuit with. Default null.
+ * @param object $args An object containing wp_nav_menu() arguments.
*/
- function end_el(&$output, $item, $depth) {
- $output .= "\n";
- }
-}
-
-/**
- * Displays a navigation menu.
- *
- * Optional $args contents:
- *
- * 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'.
- * 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.
- *
- * @since 3.0.0
- *
- * @param array $args Arguments
- */
-function wp_nav_menu( $args = array() ) {
- static $menu_id_slugs = array();
+ $nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );
- $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' => '',
- 'depth' => 0, 'walker' => '', 'theme_location' => '' );
+ if ( null !== $nav_menu ) {
+ if ( $args->echo ) {
+ echo $nav_menu;
+ return;
+ }
- $args = wp_parse_args( $args, $defaults );
- $args = apply_filters( 'wp_nav_menu_args', $args );
- $args = (object) $args;
+ return $nav_menu;
+ }
// Get the nav menu based on the requested menu
$menu = wp_get_nav_menu_object( $args->menu );
@@ -155,32 +99,50 @@ 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;
}
}
}
+ 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 ) )
- && ( function_exists($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 ) . '"' : '';
@@ -191,44 +153,95 @@ function wp_nav_menu( $args = array() ) {
// 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;
+ }
+
+ // 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 );
- unset($menu_items);
+ /**
+ * 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 );
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 .= '';
+ $wrap_class = $args->menu_class ? $args->menu_class : '';
- // Allow plugins to hook into the menu to add their own - '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 );
- $nav_menu .= $items;
- unset($items);
- $nav_menu .= '
';
+ // 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 )
@@ -241,12 +254,15 @@ function wp_nav_menu( $args = array() ) {
* 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;
@@ -287,8 +303,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 +325,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 +348,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(
@@ -351,14 +372,24 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
$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 = ( 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 ) ) ) {
+ } 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;
while(
@@ -369,14 +400,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 +429,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 +440,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 +461,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';
@@ -442,13 +487,17 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
*
* @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 );
}
/**
@@ -456,14 +505,17 @@ function walk_nav_menu_tree( $items, $depth, $r ) {
*
* @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 );
-
-?>