<?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.
- *
- * @since 3.0.0
- * @uses Walker
- */
-class Walker_Nav_Menu extends Walker {
- /**
- * What the class handles.
- *
- * @see Walker::$tree_type
- * @since 3.0.0
- * @var string
- */
- public $tree_type = array( 'post_type', 'taxonomy', 'custom' );
-
- /**
- * Database fields to use.
- *
- * @see Walker::$db_fields
- * @since 3.0.0
- * @todo Decouple this.
- * @var array
- */
- public $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 menu item. Used for padding.
- * @param array $args An array of arguments. @see wp_nav_menu()
- */
- public function start_lvl( &$output, $depth = 0, $args = array() ) {
- $indent = str_repeat("\t", $depth);
- $output .= "\n$indent<ul class=\"sub-menu\">\n";
- }
-
- /**
- * Ends the list of after the elements are added.
- *
- * @see Walker::end_lvl()
- *
- * @since 3.0.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param int $depth Depth of menu item. Used for padding.
- * @param array $args An array of arguments. @see wp_nav_menu()
- */
- public function end_lvl( &$output, $depth = 0, $args = array() ) {
- $indent = str_repeat("\t", $depth);
- $output .= "$indent</ul>\n";
- }
-
- /**
- * Start the element output.
- *
- * @see Walker::start_el()
- *
- * @since 3.0.0
- * @since 4.4.0 'nav_menu_item_args' filter was added.
- *
- * @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 array $args An array of arguments. @see wp_nav_menu()
- * @param int $id Current item ID.
- */
- public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
- $indent = ( $depth ) ? str_repeat( "\t", $depth ) : '';
-
- $classes = empty( $item->classes ) ? array() : (array) $item->classes;
- $classes[] = 'menu-item-' . $item->ID;
-
- /**
- * Filter the arguments for a single nav menu item.
- *
- * @since 4.4.0
- *
- * @param array $args An array of arguments.
- * @param object $item Menu item data object.
- * @param int $depth Depth of menu item. Used for padding.
- */
- $args = apply_filters( 'nav_menu_item_args', $args, $item, $depth );
-
- /**
- * Filter the CSS class(es) applied to a menu item's list item element.
- *
- * @since 3.0.0
- * @since 4.1.0 The `$depth` parameter was added.
- *
- * @param array $classes The CSS classes that are applied to the menu item's `<li>` element.
- * @param object $item The current menu item.
- * @param array $args An array of {@see wp_nav_menu()} arguments.
- * @param int $depth Depth of menu item. Used for padding.
- */
- $class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args, $depth ) );
- $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : '';
-
- /**
- * Filter the ID applied to a menu item's list item element.
- *
- * @since 3.0.1
- * @since 4.1.0 The `$depth` parameter was added.
- *
- * @param string $menu_id The ID that is applied to the menu item's `<li>` element.
- * @param object $item The current menu item.
- * @param array $args An array of {@see wp_nav_menu()} arguments.
- * @param int $depth Depth of menu item. Used for padding.
- */
- $id = apply_filters( 'nav_menu_item_id', 'menu-item-'. $item->ID, $item, $args, $depth );
- $id = $id ? ' id="' . esc_attr( $id ) . '"' : '';
-
- $output .= $indent . '<li' . $id . $class_names .'>';
-
- $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 anchor element.
- *
- * @since 3.6.0
- * @since 4.1.0 The `$depth` parameter was added.
- *
- * @param array $atts {
- * The HTML attributes applied to the menu item's `<a>` element, empty strings are ignored.
- *
- * @type string $title Title attribute.
- * @type string $target 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 {@see wp_nav_menu()} arguments.
- * @param int $depth Depth of menu item. Used for padding.
- */
- $atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args, $depth );
-
- $attributes = '';
- foreach ( $atts as $attr => $value ) {
- if ( ! empty( $value ) ) {
- $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
- $attributes .= ' ' . $attr . '="' . $value . '"';
- }
- }
-
- /** This filter is documented in wp-includes/post-template.php */
- $title = apply_filters( 'the_title', $item->title, $item->ID );
-
- /**
- * Filter a menu item's title.
- *
- * @since 4.4.0
- *
- * @param string $title The menu item's title.
- * @param object $item The current menu item.
- * @param array $args An array of {@see wp_nav_menu()} arguments.
- * @param int $depth Depth of menu item. Used for padding.
- */
- $title = apply_filters( 'nav_menu_item_title', $title, $item, $args, $depth );
-
- $item_output = $args->before;
- $item_output .= '<a'. $attributes .'>';
- $item_output .= $args->link_before . $title . $args->link_after;
- $item_output .= '</a>';
- $item_output .= $args->after;
-
- /**
- * Filter a menu item's starting output.
- *
- * The menu item's starting output only includes `$args->before`, the opening `<a>`,
- * the menu item's title, the closing `</a>`, and `$args->after`. Currently, there is
- * no filter for modifying the opening and closing `<li>` 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 {@see wp_nav_menu()} arguments.
- */
- $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 array $args An array of arguments. @see wp_nav_menu()
- */
- public function end_el( &$output, $item, $depth = 0, $args = array() ) {
- $output .= '</li>';
- }
-
-} // Walker_Nav_Menu
+/** Walker_Nav_Menu class */
+require_once ABSPATH . WPINC . '/class-walker-nav-menu.php';
/**
* Displays a navigation menu.
*
* @since 3.0.0
+ * @since 4.7.0 Added the `item_spacing` argument.
*
* @staticvar array $menu_id_slugs
*
* @param array $args {
* Optional. Array of nav menu 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 text. Default empty.
- * @type string $after Text after the link text. Default empty.
- * @type string $link_before Text before the link. Default empty.
- * @type string $link_after Text after the link. 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.
+ * @type int|string|WP_Term $menu Desired menu. Accepts (matching in order) id, slug, name, menu object. 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.
+ * @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'.
* }
* @return object|false|void Menu output if $echo is false, false if there are no items or no menu was found.
*/
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' => '', 'items_wrap' => '<ul id="%1$s" class="%2$s">%3$s</ul>',
+ '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>', 'item_spacing' => 'preserve',
'depth' => 0, 'walker' => '', 'theme_location' => '' );
$args = wp_parse_args( $args, $defaults );
+
+ if ( ! in_array( $args['item_spacing'], array( 'preserve', 'discard' ), true ) ) {
+ // invalid value, fall back to default.
+ $args['item_spacing'] = $defaults['item_spacing'];
+ }
+
/**
- * Filter the arguments used to display a navigation menu.
+ * Filters the arguments used to display a navigation menu.
*
* @since 3.0.0
*
$args = (object) $args;
/**
- * Filter whether to short-circuit the wp_nav_menu() output.
+ * 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,
* @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.
+ * @param stdClass $args An object containing wp_nav_menu() arguments.
*/
$nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );
$show_container = false;
if ( $args->container ) {
/**
- * Filter the list of HTML tags that are valid for use as menu containers.
+ * Filters the list of HTML tags that are valid for use as menu containers.
*
* @since 3.0.0
*
unset( $menu_items, $menu_item );
/**
- * Filter the sorted list of menu item objects before generating the menu's HTML.
+ * 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.
+ * @param array $sorted_menu_items The menu items, sorted by each menu item's menu order.
+ * @param stdClass $args An object containing wp_nav_menu() arguments.
*/
$sorted_menu_items = apply_filters( 'wp_nav_menu_objects', $sorted_menu_items, $args );
$wrap_class = $args->menu_class ? $args->menu_class : '';
/**
- * Filter the HTML list content for navigation menus.
+ * 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.
+ * @param string $items The HTML list content for the menu items.
+ * @param stdClass $args An object containing wp_nav_menu() arguments.
*/
$items = apply_filters( 'wp_nav_menu_items', $items, $args );
/**
- * Filter the HTML list content for a specific navigation menu.
+ * 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.
+ * @param string $items The HTML list content for the menu items.
+ * @param stdClass $args An object containing wp_nav_menu() arguments.
*/
$items = apply_filters( "wp_nav_menu_{$menu->slug}_items", $items, $args );
$nav_menu .= '</' . $args->container . '>';
/**
- * Filter the HTML content for navigation menus.
+ * 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.
+ * @param string $nav_menu The HTML content for the navigation menu.
+ * @param stdClass $args An object containing wp_nav_menu() arguments.
*/
$nav_menu = apply_filters( 'wp_nav_menu', $nav_menu, $args );
$possible_object_parents = array_filter( $possible_object_parents );
$front_page_url = home_url();
+ $front_page_id = (int) get_option( 'page_on_front' );
foreach ( (array) $menu_items as $key => $menu_item ) {
$classes[] = 'menu-item-type-' . $menu_item->type;
$classes[] = 'menu-item-object-' . $menu_item->object;
+ // This menu item is set as the 'Front Page'.
+ if ( 'post_type' === $menu_item->type && $front_page_id === (int) $menu_item->object_id ) {
+ $classes[] = 'menu-item-home';
+ }
+
// 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 ) ) {
$active_parent_object_ids[] = (int) $menu_item->object_id;
$classes[] = 'page-item-' . $menu_item->object_id;
$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;
* @uses Walker_Nav_Menu to create HTML list content.
* @since 3.0.0
*
- * @param array $items
- * @param int $depth
- * @param object $r
- * @return string
+ * @param array $items The menu items, sorted by each menu item's menu order.
+ * @param int $depth Depth of the item in reference to parents.
+ * @param stdClass $r An object containing wp_nav_menu() arguments.
+ * @return string The HTML list content for the menu items.
*/
function walk_nav_menu_tree( $items, $depth, $r ) {
$walker = ( empty($r->walker) ) ? new Walker_Nav_Menu : $r->walker;
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff