Walker_Nav_Menu{} WP 3.0.0

Клас ядра WordPress, який генерує HTML-код списку елементів навігаційного меню WordPress.

Дивіться wp_nav_menu() .

Працює на основі:
Walker()

Хуки із класу
$walker = новий Walker_Nav_Menu; $ args = array ( 'walker' => $walker, // ... інші параметри меню ); wp_nav_menu ($ args);

Методи

  1. public end_el( &$output, $data_object, $depth = 0, $args = null )
  2. public end_lvl( &$output, $depth = 0, $args = null )
  3. public start_el( &$output, $data_object, $depth = 0, $args = null, $current_object_id = 0 )
  4. public start_lvl( &$output, $depth = 0, $args = null )

Приклади

2

#1 Приклад Створення HTML-коду для wp_nav_menu()

Приклад розширення класу Walker_Nav_Menu для створення свого довільного HTML коду який виводиться функцією wp_nav_menu() . Наш HTML-код буде написаний спеціально для нашої теми.

Нижче є код свого довільного класу, який будує меню. Він додає глибину меню та парні/непарні CSS класи до елементів меню (обом ul і li):

Щоб не винаходити велосипед, копіюємо код класу Walker_Nav_Menu {} і просто змінюємо його, як нам потрібно.

// свій клас побудови меню: class My_Walker_Nav_Menu extends Walker_Nav_Menu { // add classes to ul sub-menus function start_lvl( &$output, $depth = 0, $args = NULL ) { // depth dependent classes $indent = ( $depth > 0 ? str_repeat( "t", $depth ) : ''); //code indent $display_depth = ($ depth + 1); // because it counts the first submenu as 0 $classes = array( 'sub-menu', ( $display_depth % 2 ? 'menu-odd' : 'menu-even' ), ( $display_depth >=2 ? 'sub-sub-menu' : '' ), 'menu-depth-'. $display_depth ); $class_names = implode('', $classes); // build html $output .= "n" . $indent. '<ul class="' . $class_names . '">' . "n"; } // add main/sub classes to li's and links function start_el( &$output, $data_object, $depth = 0, $args = null, $current_object_id = 0 ) { global $wp_query; // Зберігає більше script, specific name for use withthis method. $item = $data_object; $indent = ( $depth > 0 ? str_repeat( "t", $depth ) : ''); //code indent // depth dependent classes $depth_classes = array( ( $depth == 0 ? 'main-menu-item' : 'sub-menu-item' ), ( $depth >=2 ? 'sub-sub-menu-item' : '' ), ( $depth % 2 ? 'menu-item-odd' : 'menu-item-even' ), 'menu-item-depth-'. $depth ); $depth_class_names = esc_attr( implode( ' ', $depth_classes ) ); // passed classes $classes = empty( $item->classes )? array() : (array) $item->classes; $class_names = esc_attr( implode( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item ) ) ); // build html $output.=$indent. '<li id="nav-menu-item-'. $item->ID . '" class="' . $depth_class_names . ' ' . $class_names . '">'; // link attributes $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 ) .'"' : ''; $attributes .= ' class="menu-link ' . ( $depth > 0 ? 'sub-menu-link' : 'main-menu-link' ) . '"'; $item_output = sprintf( '%1$s<a%2$s>%3$s%4$s%5$s</a>%6$s', $args->before, $attributes, $args->link_before, apply_filters( 'the_title', $item->title, $item->ID ), $args->link_after, $args->after ); // build html $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args); } } 

Тепер, коли клас готовий, використовуємо його функції wp_nav_menu() . Для цього потрібно вказати екземпляр нашого класу у параметрі walker.

function my_nav_menu( $args ) { $ args = array_merge ([ 'container' => 'div', 'container_id' => 'top-navigation-primary', 'container_class' => 'top-navigation', 'menu_class' => 'menu main-menu menu-depth-0 menu-even', 'echo' => false, 'items_wrap' => '<ul id="%1$s" class="%2$s">%3$s</ul>', 'depth' => 10, 'walker' => new My_Walker_Nav_Menu() ], $ args); echo wp_nav_menu( $args ); }

Тепер там, де потрібно виводити меню, використовуємо нашу функцію:

my_nav_menu( [ 'theme_location' => 'navigation_menu_primary' ] );

нотатки

список змін

З версії 3.0.0Введено.

Код Walker_Nav_Menu {} WP 6.0.2

class Walker_Nav_Menu extends Walker { /** * What the class handles. * * @ Since 3.0.0 * @var string * * @see Walker::$tree_type */ public $tree_type = array( 'post_type', 'taxonomy', 'custom' ); /** * Database fields to use. * * @ Since 3.0.0 * @Toto Decouple this. * @var string[] * * @see Walker::$db_fields */ $db_fields = array( 'parent' => 'menu_item_parent', 'id' => 'db_id', ); /** * Starts the list before the elements are added. * * @ Since 3.0.0 * * @see Walker::start_lvl() * * @param string $output Використовується для отримання додаткового вмісту (passed by reference). * @param int $depth Відомості про меню. Використовується для padding. * @param stdClass $args An object of wp_nav_menu() arguments. */ public function start_lvl( &$output, $depth = 0, $args = null ) { if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) { $ t = ''; $n = ''; } else { $t = "t"; $n = "n"; } $indent = str_repeat ($ t, $ depth); // Default class. $classes = array( 'sub-menu'); /** * Filters CSS class(es) applied to a menu list element. * * @ Since 4.8.0 * * @param string[] $classes Array of the CSS classes that are applied to the menu `<ul>` element. * @param stdClass $args An object of `wp_nav_menu()` arguments. * @param int $depth Відомості про меню. Використовується для padding. */ $class_names = implode( ' ', apply_filters( 'nav_menu_submenu_css_class', $classes, $args, $depth ) ); $class_names = $class_names? 'class="' . esc_attr( $class_names ) . '"' : ''; $output .= "{$n}{$indent}<ul$class_names>{$n}"; } /** * Ends the list of after the elements are added. * * @ Since 3.0.0 * * @see Walker::end_lvl() * * @param string $output Використовується для отримання додаткового вмісту (passed by reference). * @param int $depth Відомості про меню. Використовується для padding. * @param stdClass $args An object of wp_nav_menu() arguments. */ public function end_lvl( &$output, $depth = 0, $args = null ) { if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) { $ t = ''; $n = ''; } else { $t = "t"; $n = "n"; } $indent = str_repeat ($ t, $ depth); $output .= "$indent</ul>{$n}"; } /** * Starts the element output. * * @ Since 3.0.0 * @since 4.4.0 The {@see 'nav_menu_item_args'} filter was added. * @since 5.9.0 Renamed `$item` to `$data_object` and `$id` to `$current_object_id` * до match parent class for PHP 8 назвою параметр support. * * @see Walker::start_el() * * @param string $output Використовується для отримання додаткового вмісту (passed by reference). * @param WP_Post $data_object Menu item data object. * @param int $depth Відомості про меню. Використовується для padding. * @param stdClass $args An object of wp_nav_menu() arguments. * @param int $current_object_id Optional. ID of current menu item. Default 0 */ public function start_el( &$output, $data_object, $depth = 0, $args = null, $current_object_id = 0 ) { // Зберігає більше script, specific name for use withthis method. $menu_item = $data_object; if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) { $ t = ''; $n = ''; } else { $t = "t"; $n = "n"; } $indent = ($ depth)? str_repeat( $t, $depth ) : ''; $classes = empty( $menu_item->classes ) ? array() : (array) $menu_item->classes; $classes[] = 'menu-item-' . $menu_item->ID; /** * Filters arguments for single nav menu item. * * @ Since 4.4.0 * * @param stdClass $args An object of wp_nav_menu() arguments. * @param WP_Post $menu_item Menu item data object. * @param int $depth Відомості про меню. Використовується для padding. */ $args = apply_filters( 'nav_menu_item_args', $args, $menu_item, $depth); /** * Filters the CSS classes applied to a menu item's list item element. * * @ Since 3.0.0 * @since 4.1.0 The `$depth` parameter was added. * * @param string[] $classes Array of the CSS classes, що є applied to menu menu's `<li>` element. * @param WP_Post $menu_item Текущее меню елемент об'єкта. * @param stdClass $args An object of wp_nav_menu() arguments. * @param int $depth Відомості про меню. Використовується для padding. */ $class_names = implode( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $menu_item, $args, $depth ) ); $class_names = $class_names? 'class="' . esc_attr( $class_names ) . '"' : ''; /** * Filters 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 ID, що applied to menu item's `<li>` element. * @param WP_Post $menu_item The current menu item. * @param stdClass $args An object of wp_nav_menu() arguments. * @param int $depth Відомості про меню. Використовується для padding. */ $id = apply_filters( 'nav_menu_item_id', 'menu-item-' . $menu_item->ID, $menu_item, $args, $depth ); $id = $id? ' id="' . esc_attr( $id ) . '"' : ''; $output.=$indent. '<li'. $id. $class_names . '>'; $ atts = array (); $atts['title'] = ! empty( $menu_item->attr_title ) ? $menu_item->attr_title : ''; $atts['target'] = ! empty($menu_item->target)? $menu_item->target : ''; if ( '_blank' === $menu_item->target && empty( $menu_item->xfn ) ) { $atts['rel'] = 'noopener'; } else { $atts['rel'] = $menu_item->xfn; } $atts['href'] = ! empty( $menu_item->url )? $menu_item->url : ''; $atts['aria-current'] = $menu_item->current ? 'page' : ''; /** * Filters 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 { * HTML атрибути applied to menu menu's `<a>` element, empty strings є ignored. * * @type string $title Title attribute. * @type string $target Target attribute. * @type string $rel The rel attribute. * @type string $href The href attribute. * @type string $aria-current The aria-current attribute. * } * @param WP_Post $menu_item Текущее меню елемент об'єкта. * @param stdClass $args An object of wp_nav_menu() arguments. * @param int $depth Відомості про меню. Використовується для padding. */ $atts = apply_filters( 'nav_menu_link_attributes', $atts, $menu_item, $args, $depth); $attributes = ''; foreach ( $atts as $attr => $value ) { if ( is_scalar( $value ) && '' !== $value && false !== $value ) { $value = ('href' === $attr)? esc_url($value): esc_attr($value); $attributes .= ' ' . $attr . '="' . $value . '"'; } } /** Цей filter is documented в wp-includes/post-template.php */ $title = apply_filters( 'the_title', $menu_item->title, $menu_item->ID); /** * Filters a menu item's title. * * @ Since 4.4.0 * * @param string $title Menu item's title. * @param WP_Post $menu_item Текущее меню елемент об'єкта. * @param stdClass $args An object of wp_nav_menu() arguments. * @param int $depth Відомості про меню. Використовується для padding. */ $title = apply_filters( 'nav_menu_item_title', $title, $menu_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; /** * Filters a menu item's starting output. * * The menu item's starting output тільки включає `$args->before`, the opening `<a>`, * the menu item's title, the closing `</a>`, and `$args->after`. Currently, there is * no filter для modifying the opening and closing `<li>` для menu item. * * @ Since 3.0.0 * * @param string $item_output У menu item's starting HTML output. * @param WP_Post $menu_item Menu item data object. * @param int $depth Відомості про меню. Використовується для padding. * @param stdClass $args An object of wp_nav_menu() arguments. */ $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $menu_item, $depth, $args); } /** * Ends the element output, if needed. * * @ Since 3.0.0 * @since 5.9.0 Renamed '$item' to '$data_object' для parent class class for PHP 8 named parameter support. * * @see Walker::end_el() * * @param string $output Використовується для отримання додаткового вмісту (passed by reference). * @param WP_Post $data_object Menu item data object. Не використано. * @param int $depth Відповідь на сторінці. Not Used. * @param stdClass $args An object of wp_nav_menu() arguments. */ public function end_el( &$output, $data_object, $depth = 0, $args = null ) { if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) { $ t = ''; $n = ''; } else { $t = "t"; $n = "n"; } $output .= "</li>{$n}"; } }

Залишити відповідь

Ваша e-mail адреса не оприлюднюватиметься. Обов’язкові поля позначені *