X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/61343b82c4f0da4c68e4c6373daafff4a81efdd1..9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f:/wp-includes/nav-menu-template.php diff --git a/wp-includes/nav-menu-template.php b/wp-includes/nav-menu-template.php index 0ac14c32..4d380a25 100644 --- a/wp-includes/nav-menu-template.php +++ b/wp-includes/nav-menu-template.php @@ -10,75 +10,109 @@ /** * Create HTML list of nav menu items. * - * @package WordPress * @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 */ - var $tree_type = array( 'post_type', 'taxonomy', 'custom' ); + 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 */ - var $db_fields = array( 'parent' => 'menu_item_parent', 'id' => 'db_id' ); + 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 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() ) { + public 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 = 0, $args = array(), $id = 0 ) { + public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) { $indent = ( $depth ) ? str_repeat( "\t", $depth ) : ''; - $class_names = $value = ''; - $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 + * + * @see wp_nav_menu() + * + * @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 wp_nav_menu() arguments. + */ $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 + * + * @see wp_nav_menu() + * + * @param string $menu_id The ID that is applied to the menu item's
  • . + * @param object $item The current menu item. + * @param array $args An array of wp_nav_menu() arguments. + */ $id = apply_filters( 'nav_menu_item_id', 'menu-item-'. $item->ID, $item, $args ); $id = $id ? ' id="' . esc_attr( $id ) . '"' : ''; - $output .= $indent . ''; + $output .= $indent . ''; $atts = array(); $atts['title'] = ! empty( $item->attr_title ) ? $item->attr_title : ''; @@ -86,6 +120,24 @@ class Walker_Nav_Menu extends Walker { $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 + * + * @see wp_nav_menu() + * + * @param array $atts { + * The HTML attributes applied to the menu item's , 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 wp_nav_menu() arguments. + */ $atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args ); $attributes = ''; @@ -98,51 +150,78 @@ class Walker_Nav_Menu extends Walker { $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 + * + * @see wp_nav_menu() + * + * @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 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 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() ) { + public 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_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. - * * @since 3.0.0 * - * @param array $args Arguments + * @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 callback|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. + * } + * @return mixed 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(); @@ -152,9 +231,43 @@ 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 + * + * @see wp_nav_menu() + * + * @param array $args Array of wp_nav_menu() arguments. + */ $args = apply_filters( 'wp_nav_menu_args', $args ); $args = (object) $args; + /** + * Filter 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 ); @@ -164,7 +277,7 @@ function wp_nav_menu( $args = array() ) { // get the first menu that has items if we still can't find a menu if ( ! $menu && !$args->theme_location ) { - $menus = wp_get_nav_menus(); + $menus = wp_get_nav_menus( array( 'orderby' => 'name' ) ); foreach ( $menus as $menu_maybe ) { if ( $menu_items = wp_get_nav_menu_items( $menu_maybe->term_id, array( 'update_post_term_cache' => false ) ) ) { $menu = $menu_maybe; @@ -196,6 +309,14 @@ function wp_nav_menu( $args = array() ) { $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 $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 ) ) { $show_container = true; @@ -208,12 +329,31 @@ 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. + * @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 ); @@ -235,8 +375,27 @@ 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 + * + * @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 ); + /** + * Filter 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. @@ -249,6 +408,16 @@ function wp_nav_menu( $args = array() ) { if ( $show_container ) $nav_menu .= 'container . '>'; + /** + * Filter 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 ) @@ -261,7 +430,7 @@ 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 * * @param array $menu_items The current menu item objects to which to add the class property information. */