X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/6c8f14c09105d0afa4c1574215c59b5021040e76..78ff9d91a14da1f53bd3f1ffcab1264d92359b72:/wp-includes/nav-menu-template.php?ds=sidebyside diff --git a/wp-includes/nav-menu-template.php b/wp-includes/nav-menu-template.php index df5612d2..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,11 +35,15 @@ 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 = 0, $args = array() ) { $indent = str_repeat("\t", $depth); @@ -43,11 +51,15 @@ class Walker_Nav_Menu extends Walker { } /** + * 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 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 end_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat("\t", $depth); @@ -55,14 +67,17 @@ class Walker_Nav_Menu extends Walker { } /** + * 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 = 0, $args = array(), $id = 0 ) { $indent = ( $depth ) ? str_repeat( "\t", $depth ) : ''; @@ -72,40 +87,105 @@ 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_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 = $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 = 0, $args = array() ) { $output .= "
    • \n"; } -} + +} // Walker_Nav_Menu /** * Displays a navigation menu. @@ -141,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; @@ -168,23 +255,30 @@ function wp_nav_menu( $args = array() ) { /* * If no menu was found: - * - Fallback (if one was specified), or bail. + * - Fall back (if one was specified), or bail. * * If no menu items were found: - * - Fallback, but only if no theme location was specified. + * - 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 ( !$menu || is_wp_error( $menu ) || empty( $menu_items ) ) + 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; @@ -197,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; + } + + // 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); + 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 ); @@ -224,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 ) @@ -251,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; @@ -367,7 +506,7 @@ function _wp_menu_item_classes_by_context( &$menu_items ) { $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 ) ); + $_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';