X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/5aa86a9053fb0fa15846bb60aac2fb8fdfff524a..78ff9d91a14da1f53bd3f1ffcab1264d92359b72:/wp-includes/nav-menu-template.php
diff --git a/wp-includes/nav-menu-template.php b/wp-includes/nav-menu-template.php
index ad6b5aa9..7aceb8f6 100644
--- a/wp-includes/nav-menu-template.php
+++ b/wp-includes/nav-menu-template.php
@@ -16,6 +16,8 @@
*/
class Walker_Nav_Menu extends Walker {
/**
+ * What the class handles.
+ *
* @see Walker::$tree_type
* @since 3.0.0
* @var string
@@ -23,6 +25,8 @@ class Walker_Nav_Menu extends Walker {
var $tree_type = array( 'post_type', 'taxonomy', 'custom' );
/**
+ * Database fields to use.
+ *
* @see Walker::$db_fields
* @since 3.0.0
* @todo Decouple this.
@@ -31,41 +35,51 @@ class Walker_Nav_Menu extends Walker {
var $db_fields = array( 'parent' => 'menu_item_parent', 'id' => 'db_id' );
/**
+ * Starts the list before the elements are added.
+ *
* @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.
+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args An array of arguments. @see wp_nav_menu()
*/
- function start_lvl(&$output, $depth) {
+ function start_lvl( &$output, $depth = 0, $args = array() ) {
$indent = str_repeat("\t", $depth);
$output .= "\n$indent\n";
}
/**
+ * Start the element output.
+ *
* @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
+ * @param object $item Menu item data object.
+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args An array of arguments. @see wp_nav_menu()
+ * @param int $id Current item ID.
*/
- 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,47 +87,112 @@ class Walker_Nav_Menu extends Walker {
$classes = empty( $item->classes ) ? array() : (array) $item->classes;
$classes[] = 'menu-item-' . $item->ID;
+ /**
+ * Filter the CSS class(es) applied to a menu item's .
+ *
+ * @since 3.0.0
+ *
+ * @param array $classes The CSS classes that are applied to the menu item's .
+ * @param object $item The current menu item.
+ * @param array $args An array of arguments. @see wp_nav_menu()
+ */
$class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args ) );
- $class_names = ' class="' . esc_attr( $class_names ) . '"';
-
+ $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : '';
+
+ /**
+ * Filter the ID applied to a menu item's .
+ *
+ * @since 3.0.1
+ *
+ * @param string The ID that is applied to the menu item's .
+ * @param object $item The current menu item.
+ * @param array $args An array of arguments. @see wp_nav_menu()
+ */
$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 . '';
- $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 ) .'"' : '';
+ $atts = array();
+ $atts['title'] = ! empty( $item->attr_title ) ? $item->attr_title : '';
+ $atts['target'] = ! empty( $item->target ) ? $item->target : '';
+ $atts['rel'] = ! empty( $item->xfn ) ? $item->xfn : '';
+ $atts['href'] = ! empty( $item->url ) ? $item->url : '';
+
+ /**
+ * Filter the HTML attributes applied to a menu item's .
+ *
+ * @since 3.6.0
+ *
+ * @param array $atts {
+ * The HTML attributes applied to the menu item's , empty strings are ignored.
+ *
+ * @type string $title The title attribute.
+ * @type string $target The target attribute.
+ * @type string $rel The rel attribute.
+ * @type string $href The href attribute.
+ * }
+ * @param object $item The current menu item.
+ * @param array $args An array of arguments. @see wp_nav_menu()
+ */
+ $atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args );
+
+ $attributes = '';
+ foreach ( $atts as $attr => $value ) {
+ if ( ! empty( $value ) ) {
+ $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
+ $attributes .= ' ' . $attr . '="' . $value . '"';
+ }
+ }
$item_output = $args->before;
$item_output .= '';
+ /** This filter is documented in wp-includes/post-template.php */
$item_output .= $args->link_before . apply_filters( 'the_title', $item->title, $item->ID ) . $args->link_after;
$item_output .= '';
$item_output .= $args->after;
+ /**
+ * Filter a menu item's starting output.
+ *
+ * The menu item's starting output only includes $args->before, the opening ,
+ * the menu item's title, the closing , and $args->after. Currently, there is
+ * no filter for modifying the opening and closing for a menu item.
+ *
+ * @since 3.0.0
+ *
+ * @param string $item_output The menu item's starting HTML output.
+ * @param object $item Menu item data object.
+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args An array of arguments. @see wp_nav_menu()
+ */
$output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
}
/**
+ * Ends the element output, if needed.
+ *
* @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.
+ * @param object $item Page data object. Not used.
+ * @param int $depth Depth of page. Not Used.
+ * @param array $args An array of arguments. @see wp_nav_menu()
*/
- function end_el(&$output, $item, $depth) {
+ function end_el( &$output, $item, $depth = 0, $args = array() ) {
$output .= "\n";
}
-}
+
+} // Walker_Nav_Menu
/**
* Displays a navigation menu.
*
* 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'.
@@ -125,9 +204,9 @@ class Walker_Nav_Menu extends Walker {
* 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
@@ -142,6 +221,13 @@ function wp_nav_menu( $args = array() ) {
'depth' => 0, 'walker' => '', 'theme_location' => '' );
$args = wp_parse_args( $args, $defaults );
+ /**
+ * Filter the arguments used to display a navigation menu.
+ *
+ * @since 3.0.0
+ *
+ * @param array $args Arguments from {@see wp_nav_menu()}.
+ */
$args = apply_filters( 'wp_nav_menu_args', $args );
$args = (object) $args;
@@ -156,7 +242,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;
}
@@ -165,21 +251,34 @@ 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:
+ * - 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 ) )
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 ) {
+ /**
+ * Filter the list of HTML tags that are valid for use as menu containers.
+ *
+ * @since 3.0.0
+ *
+ * @param array The acceptable HTML tags for use as menu containers, defaults as 'div' and 'nav'.
+ */
$allowed_tags = apply_filters( 'wp_nav_menu_container_allowedtags', array( 'div', 'nav' ) );
if ( in_array( $args->container, $allowed_tags ) ) {
$show_container = true;
@@ -192,12 +291,30 @@ 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;
+ }
- 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 );
+ /**
+ * Filter 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.
+ */
$sorted_menu_items = apply_filters( 'wp_nav_menu_objects', $sorted_menu_items, $args );
$items .= walk_nav_menu_tree( $sorted_menu_items, $args->depth, $args );
@@ -219,16 +336,43 @@ function wp_nav_menu( $args = array() ) {
$wrap_class = $args->menu_class ? $args->menu_class : '';
- // Allow plugins to hook into the menu to add their own 's
+ /**
+ * Filter the HTML list content for navigation menus.
+ *
+ * @since 3.0.0
+ *
+ * @param string $items The HTML list content for the menu items.
+ * @param array $args Arguments from {@see wp_nav_menu()}.
+ */
$items = apply_filters( 'wp_nav_menu_items', $items, $args );
+ /**
+ * Filter the HTML list content for a specific navigation menu.
+ *
+ * @since 3.0.0
+ *
+ * @param string $items The HTML list content for the menu items.
+ * @param array $args Arguments from {@see wp_nav_menu()}.
+ */
$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 .= 'container . '>';
+ /**
+ * Filter the HTML content for navigation menus.
+ *
+ * @since 3.0.0
+ *
+ * @param string $nav_menu The HTML content for the navigation menu.
+ * @param array $args Arguments from {@see wp_nav_menu()}.
+ */
$nav_menu = apply_filters( 'wp_nav_menu', $nav_menu, $args );
if ( $args->echo )
@@ -246,7 +390,7 @@ function wp_nav_menu( $args = array() ) {
* @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 +431,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();
@@ -334,7 +476,7 @@ 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';
@@ -361,11 +503,12 @@ function _wp_menu_item_classes_by_context( &$menu_items ) {
// if the menu item corresponds to the currently-requested URL
} elseif ( 'custom' == $menu_item->object ) {
$_root_relative_current = untrailingslashit( $_SERVER['REQUEST_URI'] );
- $current_url = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_root_relative_current;
- $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 ) );
+ $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( '/' . preg_quote( $wp_rewrite->index, '/' ) . '$/', '', $current_url ) );
- if ( in_array( $item_url, array( $current_url, $_indexless_current, $_root_relative_current ) ) ) {
+ 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;
@@ -471,7 +614,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 );
}
/**