Возможность добавить меню в тему появилась в 3-й версии WordPress. Благодаря использованию класса Walker_Nav_Menu
меню в WordPress обычно формируется в виде маркированного списка с определенным набором классов для элементов <ul>
, <li>
и реже - для <a>
. Давайте разберемся, как добавить и управлять формированием меню в WordPress.
Добавление меню в теме
Для начала давайте поговорим о том, каким образом мы можем указать в нашей теме, что у нас есть область для меню. Для этого в файле functions.php необходимо зарегистрировать место для меню, с помощью register_nav_menu()
:
1 2 3 4 | register_nav_menus(array( 'primary' => __('Primary menu', 'mytheme'), //местоположение основного меню в шаблоне 'footer-menu' => __('Footer menu', 'mytheme') //местоположение меню в футере вашего шаблона )); |
После сохранения в админке WordPress слева в меню Внешний вид добавится пункт Меню.
Обратите внимание, что функция называется register_nav_menus()
с английским "s" в конце и принимает в качестве параметра массив. Т.е. она изначально предназначена для регистрации нескольких меню. Чаще всего меню добавляют в хедер и футер (пример в коде), но вы также можете размещать меню в боковой колонке, тогда в массиве у вас будет 3, а не 2 элемента. Если у вас одно меню, то оно указывается в виде единственного аргумента массива параметров функции register_nav_menus()
.
register_nav_menu()
, поддержка меню темой включается автоматически. Вы также можете добавить такую поддержку с помощью функции add_theme_support( 'menus' );
Функция register_nav_menu()
регистрирует месторасположение вашего меню, но само меню при этом не создается и не отображается в теме. Для этого существует другая функция.
Функция wp_nav_menu()
Функция wp_nav_menu()
предназначена для вывода вашего меню в том месте шаблона, в котором вы ее размещаете. У нее достаточно много параметров:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | wp_nav_menu( array( 'menu' => '', // (string) Название выводимого меню (указывается в админке при создании меню, приоритетнее // чем указанное местоположение theme_location - если указано, то параметр theme_location игнорируется) 'container' => 'div', // (string) Тег-контейнер для меню (по умолчанию div). Элемент, в котором находится ul с пунктами меню. 'container_class' => '', // (string) class контейнера (тега div или другого из параметра container) 'container_id' => '', // (string) id контейнера (тега div или другого из параметра container) 'menu_class' => 'menu', // (string) class самого меню (тега ul) 'menu_id' => '', // (string) id самого меню (тега ul) 'echo' => true, // (boolean) Выводить на экран или возвращать для обработки 'fallback_cb' => 'wp_page_menu', // (string) Используемая (резервная) функция, если меню не существует (не удалось получить) 'before' => '', // (string) Текст перед <a> каждой ссылки 'after' => '', // (string) Текст после </a> каждой ссылки 'link_before' => '', // (string) Текст перед анкором (текстом) ссылки 'link_after' => '', // (string) Текст после анкора (текста) ссылки 'depth' => 0, // (integer) Глубина вложенности (0 - неограничена, 2 - двухуровневое меню) 'walker' => '', // (object) Класс собирающий меню. По умолчанию: new Walker_Nav_Menu() 'theme_location' => '' // (string) Расположение меню в шаблоне. (указывается имя, под которым было зарегистрировано меню в функции register_nav_menus) ) ); |
Чаще всего эти параметры используются частично. Например, достаточно бывает указать только 'theme_location'
. Например, у нас есть меню в футере:
1 2 3 4 5 6 7 8 | <?php wp_nav_menu( array( 'theme_location' => 'footer-menu', 'depth' => 1, ) ); ?> |
Здесь мы, кроме области размещения меню, указываем, что у нас будут только основные ссылки (1-го уровня), без вложенных элементов.
Изменяем классы в элементах <li>
По умолчанию меню выводит элементы <li> с довольно большим списком стандартных классов. Код может выглядеть так:
1 2 3 4 | <li id="menu-item-97" class="menu-item menu-item-type-post_type menu-item-object-page current-menu-item page_item page-item-94 current_page_item current_page_parent menu-item-has-children menu-item-97"> <a href="http://mysite/articles/" aria-current="page">Статьи</a> </li> |
Допустим, нам необходимо добавить какие-либо классы к элементам <li>
, кроме уже существующих? хоть их и ооочень много. Мы можем сделать это по условию, добавив хук-фильтр для 'nav_menu_css_class'
. Например, нам нужно, чтобы class="blogpost"
был добавлен к <li>
, если они указывают на любой из постов или на страницу блога, которая выводит ссылки на все посты. Тогда нам подойдет такой код:
1 2 3 4 5 6 7 | add_filter( 'nav_menu_css_class', 'blogpost_nav_class', 10, 2 ); function blogpost_nav_class($classes, $item){ if( $item->object=='post' || $item->title == "Статьи" ){ $classes[] = "blogpost"; } return $classes; } |
Второй вариант, для того же хука 'nav_menu_css_class'
зарегистрировать функцию, которая описывает дополнительные атрибуты. Например, мы хотим добавить класс .py-1
, управляющий свойством padding
в Bootstrap, к элементам меню в футере. Тогда нам нужно описать функцию, в которой будет дополнительный, нестандартный аргумент для wp_nav_menu()
. Назовем его add_li_class
.
Код функции в functions.php:
1 2 3 4 5 6 7 | function add_additional_menu_li_classes($classes, $item, $args){ if(isset($args->add_li_class)) { $classes[] = $args->add_li_class; } return $classes; } add_filter('nav_menu_css_class', 'add_additional_menu_li_classes', 1, 3); |
В файле footer.php
вызываем функцию wp_nav_menu()
с этим аргументом:
1 2 3 4 5 6 7 | $menu = wp_nav_menu( array( 'theme_location' => 'footer-menu', 'depth' => 1, 'add_li_class' =>'py-1' ) ); |
В результате только в меню в футере будет добавлен класс p-1
.
Если же вы хотите добавить этот класс ко всем элементам <li>
во всех меню, то нужно добавить такой код:
1 2 3 4 5 | add_filter( 'nav_menu_css_class', 'add_some_class_to_nav_menu', 10, 2 ); function add_some_class_to_nav_menu( $classes, $item ){ $classes[] = 'p-1'; return $classes; } |
В стандартном меню, выводимом WordPress, массиве $classes
имеет такое содержимое (классы):
1 2 3 4 5 6 | Array( [1] => menu-item [2] => menu-item-type-post_type [3] => menu-item-object-page [4] => menu-item-112 //цифра может отличаться ) |
Однако, в случае добавления одного и того же класса во все элементы <li>
стоит, возможно, подумать о том, что проще дописать css-свойство(-а) для этих <li>
в style.css?
Можно убрать все классы из элементов <li>
, заменив их на класс 'menu-item'
, плюс для текущей открытой пользователем страницы добавить класс active
:
1 2 3 4 5 6 7 8 9 10 11 | add_filter('nav_menu_css_class','remove_nav_menu_classes'); function remove_nav_menu_classes($classes) { if ( in_array("current-menu-item", $classes ) ) { unset( $classes ); $classes[0]= 'menu-item active'; } else { $classes = array(); $classes[0]= 'menu-item'; } return $classes; } |
Убираем id в элементах <li>
Тут очень простой код:
1 | add_filter('nav_menu_item_id', '__return_false'); |
Надеюсь, вы уже применили какой-либо код, приведенный выше, и убедились, что вид вывода меню можно переопределить с помощью фильтров. Иногда в этом случае может измениться вывод всех меню на сайте, иногда вывод одного меню.
Использование класса Walker_Nav_Menu
Это, пожалуй, самый интересный вариант формирования WordPress-меню, но и самый сложный для понимания. Класс Walker_Nav_Menu - это "обходчик" меню, который управляет выводом элементов <ul>
и <li>
для всех меню по умолчанию и для вашего конкретного меню, если вы укажете в нем другой параметр "walker".
Для начала нам нужно где-то разместить код класса, который будет расширять функционал стандартного класса Walker_Nav_Menu. Можно это сделать в functions.php, но код может быть довольно длинным, поэтому его обычно выносят в отдельный файл, например, с именем nav_walker.php и размещают в папке inc. Затем самый простой способ сделать его видимым для темы - это подключить данный файл в functions.php с помощью require:
1 | require get_template_directory() . '/inc/nav_walker.php'; |
Длинный способ - зарегистрировать файл nav_walker.php примерно таким же способом:
1 2 3 4 5 6 | if(!function_exists('register_navwalker')){ function register_navwalker(){ require('inc/nav_walker.php'); } } add_action('after_setup_theme','register_navwalker'); |
Затем необходимо вызвать код этого класса в том файле темы, который предназначен для вывода меню. Обычно это header.php, footer.php или реже sidebar.php.
1 2 3 4 | wp_nav_menu( array( 'theme_location' => 'Primary', 'walker' => new Theme_Nav_Walker(), ) ); |
Ну, и самое главное - код в файле nav_walker.php. Здесь мы расширяем стандартный класс Walker_Nav_Menu
и используем для этого нескольких функций:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | class Theme_Nav_Walker extends Walker_Nav_Menu { function start_lvl( &$output, $depth = 0, $args = array() ) { //код } function end_lvl( &$output, $depth = 0, $args = array() ) { //код } function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) { //код } function end_el( &$output, $object, $depth = 0, $args = array() ) { //код } } |
Аргументы функций:
$output
- определяет, какое HTML-содержимое будет выведено,$depth
- определяет глубину вложенности элемента,$args
- представляет собой массив дополнительных аргументов.
Сами функции (методы класса) описывают следующее:
start_lvl
— (начало уровня) описывает открывающий тег. В случае списков это будет начало нового «подсписка», и поэтому здесь идет вывод тега<ul>
.end_lvl
– (конец уровня) закрывает любой тег, который ранее был открыт методомstart_lvl
. В примере меню навигации эта функция отвечает за завершение подсписка закрывающим тегом списка.</ul>
start_el
— (начало элемента) используется для отображения открывающего HTML-тега текущего элемента. В случае меню это означает<li>
тег и ссылку на элемент.end_el
– (конец элемента) вызывается после того, как Walker создает элемент со всеми его дочерними элементами и возвращает закрывающий тег. Обычно в меню это закрывающий тег</li>
.
Если заглянуть в класс Walker_Nav_Menu, то вы увидите, что в функции start_lvl
определяются отступы и класс sub-menu для вложенных ul
-элементов, в функции end_lvl
закрывается элемент ul
и тоже описываются отступы. Функция start_el
добавляет отступы к элементам <li>
, описывает их классы и id
, добавляет параметры before
и after
для <li>
, а также link_before
и link_before
для ссылок. Функция end_el
описывает отступы и закрывает элемент </li>
.
Можно в вашем классе использовать одну или 2 функции из перечисленных, если вы вносите изменения, например, только в вывод элементов <li>
и вложенных в них <a>
. Тогда вам точно нужна функция start_el
и, возможно, end_el
.
Пример вывода меню только из ссылок
Такой способ формирования меню обычно нужен в футере для вывода так называемых "технических" меню с ссылками на страницы политики конфиденциальности, возврата товара, дисклаймеры и т.п., которые пользователи читают, прямо скажем, редко, но наличие их на сайте обязательно.
Использование списков в этом случае не нужно, достаточно просто элементов <a>
.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | <?php // Разместите код в нужном файле вашей темы, например, в footer.php // Удаляем обертку в виде <ul>, используя для items_wrap значение ('%3$s'), // Класс Nav_Footer_Walker удаляет обертку из <li> для ссылок. wp_nav_menu( array( 'items_wrap'=> '%3$s', 'walker' => new Nav_Footer_Walker(), 'container'=>false, 'menu_class' => '', 'theme_location'=>'footer', 'fallback_cb'=>false ) ); ?> |
Код класса Nav_Footer_Walker:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | <?php // в файле functions.php class Nav_Footer_Walker extends Walker_Nav_Menu { function start_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat("\t", $depth); $output .= "\n$indent\n"; } function end_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat("\t", $depth); $output .= "$indent\n"; } 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; $class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args ) ); $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : ''; $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 ) .'"' : ''; $item_output = $args->before; $item_output .= '<a'. $attributes .'>'; $item_output .= $args->link_before . apply_filters( 'the_title', $item->title, $item->ID ) . $args->link_after; $item_output .= '</a>'; $item_output .= $args->after; $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args ); } function end_el( &$output, $item, $depth = 0, $args = array() ) { $output .= "\n"; } } |
Автор этого кода
Пример вывода выпадающего меню
Давайте изменим вывод меню в шапке сайта. Как правило, часть пунктов меню являются выпадающими. Поэтому добавим свой walker:
1 2 3 4 | wp_nav_menu( array( 'theme_location' => 'primary', 'walker' => new WP_DropMenu_Navwalker(), ) ); |
В качестве основы для стилей и классов будем использовать такой пример:
See the Pen Responsive Multilevel Dropdown menu by Elen (@ambassador)on CodePen.
Больше примеров в статье Примеры выпадающих меню (dropdown menu)
В файле nav_walker.php размещаем код класса Dropdown_CSS_Menu_Walker:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | class Dropdown_CSS_Menu_Walker extends Walker { var $db_fields = array( 'parent' => 'menu_item_parent', 'id' => 'db_id' ); function start_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat("\t", $depth); $output .= " class='drop-menu'>\n"; } function end_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat("\t", $depth); $output .= "$indent</ul>\n"; } function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) { global $wp_query; $indent = ( $depth ) ? str_repeat( "\t", $depth ) : ''; $class_names = $value = ''; $classes = empty( $item->classes ) ? array() : (array) $item->classes; $unusedClasses = array('menu-item-type-post_type','menu-item-object-page', 'menu-item-type-custom', 'menu-item-object-custom', 'page_item'); $classes = array_diff($classes, $unusedClasses); /* Add active class */ if(in_array('current-menu-item', $classes)) { $classes[] = 'active'; unset($classes['current-menu-item']); } /* Check for children */ $children = get_posts(array('post_type' => 'nav_menu_item', 'nopaging' => true, 'numberposts' => 1, 'meta_key' => '_menu_item_menu_item_parent', 'meta_value' => $item->ID)); $class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args ) ); $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : ''; //without id $output .= $indent . '<li' . $value . $class_names .'>'; $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 ) .'"' : ''; $item_output .= '<a'. $attributes .'>'; $item_output .= $args->link_before . apply_filters( 'the_title', $item->title, $item->ID ) . $args->link_after; if(!empty($children)) $item_output .= '<i class="arrow"></i>'; $item_output .= '</a>'; $item_output .= $args->after; if(!empty($children)) $item_output .= '<ul id="dropmenu-'.$item->ID.'"'; $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args ); } function end_el( &$output, $item, $depth = 0, $args = array() ) { $output .= "</li>\n"; } } |
Здесь мы удалили ряд классов из элементов <li>
в меню, например, 'menu-item-type-post_type'
и 'menu-item-object-page'
, а также их id
, просто не включив строчки с формированием id
в код.
Код с новым walker несколько изменим и добавим в файле header.php:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | <header> <nav> <div class="navbar"> <div class='menu-btn' role="button"> <div class="line"></div> <div class="line"></div> <div class="line"></div> </div> <div class="header-logo"> <div class="logo"> <?php the_custom_logo(); ?> </div> </div> <div class="nav-links"> <div class="sidebar-menu"> <div class="logo menu-name"> <?php the_custom_logo(); ?> </div> <span class='close-menu' role="button">×</span> </div> <?php wp_nav_menu( array( 'theme_location' => 'primary', 'menu_id' => 'primary-menu', 'container' => false, 'menu_class' => 'links', 'walker' => new Dropdown_CSS_Menu_Walker() ) ); ?> </div> </div><!--/.navbar--> </nav> </header> |
Наверняка у вас есть еще файлы с js и css-кодом. В них нужно добавить js-код и стили из примера. Вполне возможно, часть из них нужно будет подправить в соответствии со стилями темы.
Меню для WordPress при использовании Bootstrap
Для Bootstrap 5
Источник Bootstrap-5 wordpress-navbar-walker
Код в файле bootstrap5_wp_nav_menu_walker.php. Этот файл нужно подключить в functions.php.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 | <?php // bootstrap 5 wp_nav_menu walker class bootstrap_5_wp_nav_menu_walker extends Walker_Nav_menu { private $current_item; private $dropdown_menu_alignment_values = [ 'dropdown-menu-start', 'dropdown-menu-end', 'dropdown-menu-sm-start', 'dropdown-menu-sm-end', 'dropdown-menu-md-start', 'dropdown-menu-md-end', 'dropdown-menu-lg-start', 'dropdown-menu-lg-end', 'dropdown-menu-xl-start', 'dropdown-menu-xl-end', 'dropdown-menu-xxl-start', 'dropdown-menu-xxl-end' ]; function start_lvl(&$output, $depth = 0, $args = null) { $dropdown_menu_class[] = ''; foreach($this->current_item->classes as $class) { if(in_array($class, $this->dropdown_menu_alignment_values)) { $dropdown_menu_class[] = $class; } } $indent = str_repeat("\t", $depth); $submenu = ($depth > 0) ? ' sub-menu' : ''; $output .= "\n$indent<ul class=\"dropdown-menu$submenu " . esc_attr(implode(" ",$dropdown_menu_class)) . " depth_$depth\">\n"; } function start_el(&$output, $item, $depth = 0, $args = null, $id = 0) { $this->current_item = $item; $indent = ($depth) ? str_repeat("\t", $depth) : ''; $li_attributes = ''; $class_names = $value = ''; $classes = empty($item->classes) ? array() : (array) $item->classes; $classes[] = ($args->walker->has_children) ? 'dropdown' : ''; $classes[] = 'nav-item'; $classes[] = 'nav-item-' . $item->ID; if ($depth && $args->walker->has_children) { $classes[] = 'dropdown-menu dropdown-menu-end'; } $class_names = join(' ', apply_filters('nav_menu_css_class', array_filter($classes), $item, $args)); $class_names = ' class="' . esc_attr($class_names) . '"'; $id = apply_filters('nav_menu_item_id', 'menu-item-' . $item->ID, $item, $args); $id = strlen($id) ? ' id="' . esc_attr($id) . '"' : ''; $output .= $indent . '<li ' . $id . $value . $class_names . $li_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) . '"' : ''; $active_class = ($item->current || $item->current_item_ancestor || in_array("current_page_parent", $item->classes, true) || in_array("current-post-ancestor", $item->classes, true)) ? 'active' : ''; $nav_link_class = ( $depth > 0 ) ? 'dropdown-item ' : 'nav-link '; $attributes .= ( $args->walker->has_children ) ? ' class="'. $nav_link_class . $active_class . ' dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false"' : ' class="'. $nav_link_class . $active_class . '"'; $item_output = $args->before; $item_output .= '<a' . $attributes . '>'; $item_output .= $args->link_before . apply_filters('the_title', $item->title, $item->ID) . $args->link_after; $item_output .= '</a>'; $item_output .= $args->after; $output .= apply_filters('walker_nav_menu_start_el', $item_output, $item, $depth, $args); } } // register a new menu register_nav_menu('main-menu', 'Main menu'); |
В файле functions.php:
1 | register_nav_menu('main-menu', 'Main menu'); |
В файле header.php:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | <nav class="navbar navbar-expand-md navbar-light bg-light"> <div class="container-fluid"> <a class="navbar-brand" href="#">Navbar</a> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#main-menu" aria-controls="main-menu" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <div class="collapse navbar-collapse" id="main-menu"> <?php wp_nav_menu(array( 'theme_location' => 'main-menu', 'container' => false, 'menu_class' => '', 'fallback_cb' => '__return_false', 'items_wrap' => '<ul id="%1$s" class="navbar-nav me-auto mb-2 mb-md-0 %2$s">%3$s</ul>', 'depth' => 2, 'walker' => new bootstrap_5_wp_nav_menu_walker() )); ?> </div> </div> </nav> |
Дополнительные настройки:
- На странице «Внешний вид» → «Меню» WordPress установите флажок «Классы CSS» в разделе «Параметры экрана» ;
- Добавьте пользовательскую ссылку с «#» в поле URL-адреса (это будет родительский элемент раскрывающегося списка);
- В поле «Классы CSS» добавьте любой из следующих классов выравнивания: 'dropdown-menu-start', 'dropdown-menu-end', 'dropdown-menu-sm-start', 'dropdown-menu-sm-end', 'dropdown-menu-md-start', 'dropdown-menu-md-end', 'dropdown-menu-lg-start', 'dropdown-menu-lg-end', 'dropdown-menu-xl-start', 'dropdown-menu-xl-end', 'dropdown-menu-xxl-start', 'dropdown-menu-xxl-end';
- Если какой-либо из упомянутых выше классов обнаружен, он будет автоматически скопирован в элемент ul.dropdown-menu, соответствующий структуре Bootstrap 5;
- Любой другой класс, не связанный с выравниванием раскрывающегося меню, не учитывается.
Меню для WordPress при использовании Bootstrap 4
Если вы используете Bootstrap 4 для создания файлов темы и решили использовать его классы для формирования меню, то вам пригодятся следующие ссылки:
- WP Bootstrap Navwalker for fully implementing the Bootstrap 4 navigation style
- Мега-меню для Bootstrap-4
- Walker Menu WordPress per BootStrap Dropdown e Hover
- wp-bootstrap-navwalker
Пример:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 | <?php /** * WP Bootstrap Navwalker * * @package WP-Bootstrap-Navwalker * * @wordpress-plugin * Plugin Name: WP Bootstrap Navwalker * Plugin URI: https://github.com/wp-bootstrap/wp-bootstrap-navwalker * Description: A custom WordPress nav walker class to implement the Bootstrap 4 navigation style in a custom theme using the WordPress built in menu manager. * Author: Edward McIntyre - @twittem, WP Bootstrap, William Patton - @pattonwebz, IanDelMar - @IanDelMar * Version: 4.3.0 * Author URI: https://github.com/wp-bootstrap * GitHub Plugin URI: https://github.com/wp-bootstrap/wp-bootstrap-navwalker * GitHub Branch: master * License: GPL-3.0+ * License URI: http://www.gnu.org/licenses/gpl-3.0.txt */ // Check if Class Exists. if ( ! class_exists( 'WP_Bootstrap_Navwalker' ) ) : /** * WP_Bootstrap_Navwalker class. */ class WP_Bootstrap_Navwalker extends Walker_Nav_Menu { /** * Whether the items_wrap contains schema microdata or not. * * @since 4.2.0 * @var boolean */ private $has_schema = false; /** * Ensure the items_wrap argument contains microdata. * * @since 4.2.0 */ public function __construct() { if ( ! has_filter( 'wp_nav_menu_args', array( $this, 'add_schema_to_navbar_ul' ) ) ) { add_filter( 'wp_nav_menu_args', array( $this, 'add_schema_to_navbar_ul' ) ); } } /** * Starts the list before the elements are added. * * @since WP 3.0.0 * * @see Walker_Nav_Menu::start_lvl() * * @param string $output Used to append additional content (passed by reference). * @param int $depth Depth of menu item. Used for padding. * @param WP_Nav_Menu_Args $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 to add to the file. $classes = array( 'dropdown-menu' ); /** * Filters the CSS class(es) applied to a menu list element. * * @since WP 4.8.0 * * @param array $classes The CSS classes that are applied to the menu `<ul>` element. * @param stdClass $args An object of `wp_nav_menu()` arguments. * @param int $depth Depth of menu item. Used for padding. */ $class_names = join( ' ', apply_filters( 'nav_menu_submenu_css_class', $classes, $args, $depth ) ); $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : ''; /* * The `.dropdown-menu` container needs to have a labelledby * attribute which points to it's trigger link. * * Form a string for the labelledby attribute from the the latest * link with an id that was added to the $output. */ $labelledby = ''; // Find all links with an id in the output. preg_match_all( '/(<a.*?id=\"|\')(.*?)\"|\'.*?>/im', $output, $matches ); // With pointer at end of array check if we got an ID match. if ( end( $matches[2] ) ) { // Build a string to use as aria-labelledby. $labelledby = 'aria-labelledby="' . esc_attr( end( $matches[2] ) ) . '"'; } $output .= "{$n}{$indent}<ul$class_names $labelledby>{$n}"; } /** * Starts the element output. * * @since WP 3.0.0 * @since WP 4.4.0 The {@see 'nav_menu_item_args'} filter was added. * * @see Walker_Nav_Menu::start_el() * * @param string $output Used to append additional content (passed by reference). * @param WP_Nav_Menu_Item $item Menu item data object. * @param int $depth Depth of menu item. Used for padding. * @param WP_Nav_Menu_Args $args An object of wp_nav_menu() arguments. * @param int $id Current item ID. */ public function start_el( &$output, $item, $depth = 0, $args = null, $id = 0 ) { if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) { $t = ''; $n = ''; } else { $t = "\t"; $n = "\n"; } $indent = ( $depth ) ? str_repeat( $t, $depth ) : ''; if ( false !== strpos( $args->items_wrap, 'itemscope' ) && false === $this->has_schema ) { $this->has_schema = true; $args->link_before = '<span itemprop="name">' . $args->link_before; $args->link_after .= '</span>'; } $classes = empty( $item->classes ) ? array() : (array) $item->classes; // Updating the CSS classes of a menu item in the WordPress Customizer preview results in all classes defined // in that particular input box to come in as one big class string. $split_on_spaces = function ( $class ) { return preg_split( '/\s+/', $class ); }; $classes = $this->flatten( array_map( $split_on_spaces, $classes ) ); /* * Initialize some holder variables to store specially handled item * wrappers and icons. */ $linkmod_classes = array(); $icon_classes = array(); /* * Get an updated $classes array without linkmod or icon classes. * * NOTE: linkmod and icon class arrays are passed by reference and * are maybe modified before being used later in this function. */ $classes = $this->separate_linkmods_and_icons_from_classes( $classes, $linkmod_classes, $icon_classes, $depth ); // Join any icon classes plucked from $classes into a string. $icon_class_string = join( ' ', $icon_classes ); /** * Filters the arguments for a single nav menu item. * * @since WP 4.4.0 * * @param WP_Nav_Menu_Args $args An object of wp_nav_menu() arguments. * @param WP_Nav_Menu_Item $item Menu item data object. * @param int $depth Depth of menu item. Used for padding. * * @var WP_Nav_Menu_Args */ $args = apply_filters( 'nav_menu_item_args', $args, $item, $depth ); // Add .dropdown or .active classes where they are needed. if ( $this->has_children ) { $classes[] = 'dropdown'; } if ( in_array( 'current-menu-item', $classes, true ) || in_array( 'current-menu-parent', $classes, true ) ) { $classes[] = 'active'; } // Add some additional default classes to the item. $classes[] = 'menu-item-' . $item->ID; $classes[] = 'nav-item'; // Allow filtering the classes. $classes = apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args, $depth ); // Form a string of classes in format: class="class_names". $class_names = join( ' ', $classes ); $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : ''; /** * Filters the ID applied to a menu item's list item element. * * @since WP 3.0.1 * @since WP 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 WP_Nav_Menu_Item $item The current menu item. * @param WP_Nav_Menu_Args $args An object of 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 . '>'; // Initialize array for holding the $atts for the link item. $atts = array(); $atts['title'] = ! empty( $item->attr_title ) ? $item->attr_title : ''; $atts['target'] = ! empty( $item->target ) ? $item->target : ''; if ( '_blank' === $item->target && empty( $item->xfn ) ) { $atts['rel'] = 'noopener noreferrer'; } else { $atts['rel'] = ! empty( $item->xfn ) ? $item->xfn : ''; } // If the item has_children add atts to <a>. if ( $this->has_children && 0 === $depth ) { $atts['href'] = '#'; $atts['data-toggle'] = 'dropdown'; $atts['aria-expanded'] = 'false'; $atts['class'] = 'dropdown-toggle nav-link'; $atts['id'] = 'menu-item-dropdown-' . $item->ID; } else { if ( true === $this->has_schema ) { $atts['itemprop'] = 'url'; } $atts['href'] = ! empty( $item->url ) ? $item->url : '#'; // For items in dropdowns use .dropdown-item instead of .nav-link. if ( $depth > 0 ) { $atts['class'] = 'dropdown-item'; } else { $atts['class'] = 'nav-link'; } } $atts['aria-current'] = $item->current ? 'page' : ''; // Update atts of this item based on any custom linkmod classes. $atts = $this->update_atts_for_linkmod_type( $atts, $linkmod_classes ); // Allow filtering of the $atts array before using it. $atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args, $depth ); // Build a string of html containing all the atts for the item. $attributes = ''; foreach ( $atts as $attr => $value ) { if ( ! empty( $value ) ) { $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value ); $attributes .= ' ' . $attr . '="' . $value . '"'; } } // Set a typeflag to easily test if this is a linkmod or not. $linkmod_type = $this->get_linkmod_type( $linkmod_classes ); // START appending the internal item contents to the output. $item_output = isset( $args->before ) ? $args->before : ''; /* * This is the start of the internal nav item. Depending on what * kind of linkmod we have we may need different wrapper elements. */ if ( '' !== $linkmod_type ) { // Is linkmod, output the required element opener. $item_output .= $this->linkmod_element_open( $linkmod_type, $attributes ); } else { // With no link mod type set this must be a standard <a> tag. $item_output .= '<a' . $attributes . '>'; } /* * Initiate empty icon var, then if we have a string containing any * icon classes form the icon markup with an <i> element. This is * output inside of the item before the $title (the link text). */ $icon_html = ''; if ( ! empty( $icon_class_string ) ) { // Append an <i> with the icon classes to what is output before links. $icon_html = '<i class="' . esc_attr( $icon_class_string ) . '" aria-hidden="true"></i> '; } /** This filter is documented in wp-includes/post-template.php */ $title = apply_filters( 'the_title', $item->title, $item->ID ); /** * Filters a menu item's title. * * @since WP 4.4.0 * * @param string $title The menu item's title. * @param WP_Nav_Menu_Item $item The current menu item. * @param WP_Nav_Menu_Args $args An object of 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 ); // If the .sr-only class was set apply to the nav items text only. if ( in_array( 'sr-only', $linkmod_classes, true ) ) { $title = $this->wrap_for_screen_reader( $title ); $keys_to_unset = array_keys( $linkmod_classes, 'sr-only', true ); foreach ( $keys_to_unset as $k ) { unset( $linkmod_classes[ $k ] ); } } // Put the item contents into $output. $item_output .= isset( $args->link_before ) ? $args->link_before . $icon_html . $title . $args->link_after : ''; /* * This is the end of the internal nav item. We need to close the * correct element depending on the type of link or link mod. */ if ( '' !== $linkmod_type ) { // Is linkmod, output the required closing element. $item_output .= $this->linkmod_element_close( $linkmod_type ); } else { // With no link mod type set this must be a standard <a> tag. $item_output .= '</a>'; } $item_output .= isset( $args->after ) ? $args->after : ''; // END appending the internal item contents to the output. $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args ); } /** * Menu fallback. * * If this function is assigned to the wp_nav_menu's fallback_cb variable * and a menu has not been assigned to the theme location in the WordPress * menu manager the function will display nothing to a non-logged in user, * and will add a link to the WordPress menu manager if logged in as an admin. * * @param array $args passed from the wp_nav_menu function. * @return string|void String when echo is false. */ public static function fallback( $args ) { if ( ! current_user_can( 'edit_theme_options' ) ) { return; } // Initialize var to store fallback html. $fallback_output = ''; // Menu container opening tag. $show_container = false; if ( $args['container'] ) { /** * Filters the list of HTML tags that are valid for use as menu containers. * * @since WP 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 ( is_string( $args['container'] ) && in_array( $args['container'], $allowed_tags, true ) ) { $show_container = true; $class = $args['container_class'] ? ' class="menu-fallback-container ' . esc_attr( $args['container_class'] ) . '"' : ' class="menu-fallback-container"'; $id = $args['container_id'] ? ' id="' . esc_attr( $args['container_id'] ) . '"' : ''; $fallback_output .= '<' . $args['container'] . $id . $class . '>'; } } // The fallback menu. $class = $args['menu_class'] ? ' class="menu-fallback-menu ' . esc_attr( $args['menu_class'] ) . '"' : ' class="menu-fallback-menu"'; $id = $args['menu_id'] ? ' id="' . esc_attr( $args['menu_id'] ) . '"' : ''; $fallback_output .= '<ul' . $id . $class . '>'; $fallback_output .= '<li class="nav-item"><a href="' . esc_url( admin_url( 'nav-menus.php' ) ) . '" class="nav-link" title="' . esc_attr__( 'Add a menu', 'wp-bootstrap-navwalker' ) . '">' . esc_html__( 'Add a menu', 'wp-bootstrap-navwalker' ) . '</a></li>'; $fallback_output .= '</ul>'; // Menu container closing tag. if ( $show_container ) { $fallback_output .= '</' . $args['container'] . '>'; } // if $args has 'echo' key and it's true echo, otherwise return. if ( array_key_exists( 'echo', $args ) && $args['echo'] ) { // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped echo $fallback_output; } else { return $fallback_output; } } /** * Filter to ensure the items_Wrap argument contains microdata. * * @since 4.2.0 * * @param array $args The nav instance arguments. * @return array $args The altered nav instance arguments. */ public function add_schema_to_navbar_ul( $args ) { if ( isset( $args['items_wrap'] ) ) { $wrap = $args['items_wrap']; if ( strpos( $wrap, 'SiteNavigationElement' ) === false ) { $args['items_wrap'] = preg_replace( '/(>).*>?\%3\$s/', ' itemscope itemtype="http://www.schema.org/SiteNavigationElement"$0', $wrap ); } } return $args; } /** * Find any custom linkmod or icon classes and store in their holder * arrays then remove them from the main classes array. * * Supported linkmods: .disabled, .dropdown-header, .dropdown-divider, .sr-only * Supported iconsets: Font Awesome 4/5, Glypicons * * NOTE: This accepts the linkmod and icon arrays by reference. * * @since 4.0.0 * * @param array $classes an array of classes currently assigned to the item. * @param array $linkmod_classes an array to hold linkmod classes. * @param array $icon_classes an array to hold icon classes. * @param integer $depth an integer holding current depth level. * * @return array $classes a maybe modified array of classnames. */ private function separate_linkmods_and_icons_from_classes( $classes, &$linkmod_classes, &$icon_classes, $depth ) { // Loop through $classes array to find linkmod or icon classes. foreach ( $classes as $key => $class ) { /* * If any special classes are found, store the class in it's * holder array and and unset the item from $classes. */ if ( preg_match( '/^disabled|^sr-only/i', $class ) ) { // Test for .disabled or .sr-only classes. $linkmod_classes[] = $class; unset( $classes[ $key ] ); } elseif ( preg_match( '/^dropdown-header|^dropdown-divider|^dropdown-item-text/i', $class ) && $depth > 0 ) { /* * Test for .dropdown-header or .dropdown-divider and a * depth greater than 0 - IE inside a dropdown. */ $linkmod_classes[] = $class; unset( $classes[ $key ] ); } elseif ( preg_match( '/^fa-(\S*)?|^fa(s|r|l|b)?(\s?)?$/i', $class ) ) { // Font Awesome. $icon_classes[] = $class; unset( $classes[ $key ] ); } elseif ( preg_match( '/^glyphicon-(\S*)?|^glyphicon(\s?)$/i', $class ) ) { // Glyphicons. $icon_classes[] = $class; unset( $classes[ $key ] ); } } return $classes; } /** * Return a string containing a linkmod type and update $atts array * accordingly depending on the decided. * * @since 4.0.0 * * @param array $linkmod_classes array of any link modifier classes. * * @return string empty for default, a linkmod type string otherwise. */ private function get_linkmod_type( $linkmod_classes = array() ) { $linkmod_type = ''; // Loop through array of linkmod classes to handle their $atts. if ( ! empty( $linkmod_classes ) ) { foreach ( $linkmod_classes as $link_class ) { if ( ! empty( $link_class ) ) { // Check for special class types and set a flag for them. if ( 'dropdown-header' === $link_class ) { $linkmod_type = 'dropdown-header'; } elseif ( 'dropdown-divider' === $link_class ) { $linkmod_type = 'dropdown-divider'; } elseif ( 'dropdown-item-text' === $link_class ) { $linkmod_type = 'dropdown-item-text'; } } } } return $linkmod_type; } /** * Update the attributes of a nav item depending on the limkmod classes. * * @since 4.0.0 * * @param array $atts array of atts for the current link in nav item. * @param array $linkmod_classes an array of classes that modify link or nav item behaviors or displays. * * @return array maybe updated array of attributes for item. */ private function update_atts_for_linkmod_type( $atts = array(), $linkmod_classes = array() ) { if ( ! empty( $linkmod_classes ) ) { foreach ( $linkmod_classes as $link_class ) { if ( ! empty( $link_class ) ) { /* * Update $atts with a space and the extra classname * so long as it's not a sr-only class. */ if ( 'sr-only' !== $link_class ) { $atts['class'] .= ' ' . esc_attr( $link_class ); } // Check for special class types we need additional handling for. if ( 'disabled' === $link_class ) { // Convert link to '#' and unset open targets. $atts['href'] = '#'; unset( $atts['target'] ); } elseif ( 'dropdown-header' === $link_class || 'dropdown-divider' === $link_class || 'dropdown-item-text' === $link_class ) { // Store a type flag and unset href and target. unset( $atts['href'] ); unset( $atts['target'] ); } } } } return $atts; } /** * Wraps the passed text in a screen reader only class. * * @since 4.0.0 * * @param string $text the string of text to be wrapped in a screen reader class. * @return string the string wrapped in a span with the class. */ private function wrap_for_screen_reader( $text = '' ) { if ( $text ) { $text = '<span class="sr-only">' . $text . '</span>'; } return $text; } /** * Returns the correct opening element and attributes for a linkmod. * * @since 4.0.0 * * @param string $linkmod_type a sting containing a linkmod type flag. * @param string $attributes a string of attributes to add to the element. * * @return string a string with the openign tag for the element with attribibutes added. */ private function linkmod_element_open( $linkmod_type, $attributes = '' ) { $output = ''; if ( 'dropdown-item-text' === $linkmod_type ) { $output .= '<span class="dropdown-item-text"' . $attributes . '>'; } elseif ( 'dropdown-header' === $linkmod_type ) { /* * For a header use a span with the .h6 class instead of a real * header tag so that it doesn't confuse screen readers. */ $output .= '<span class="dropdown-header h6"' . $attributes . '>'; } elseif ( 'dropdown-divider' === $linkmod_type ) { // This is a divider. $output .= '<div class="dropdown-divider"' . $attributes . '>'; } return $output; } /** * Return the correct closing tag for the linkmod element. * * @since 4.0.0 * * @param string $linkmod_type a string containing a special linkmod type. * * @return string a string with the closing tag for this linkmod type. */ private function linkmod_element_close( $linkmod_type ) { $output = ''; if ( 'dropdown-header' === $linkmod_type || 'dropdown-item-text' === $linkmod_type ) { /* * For a header use a span with the .h6 class instead of a real * header tag so that it doesn't confuse screen readers. */ $output .= '</span>'; } elseif ( 'dropdown-divider' === $linkmod_type ) { // This is a divider. $output .= '</div>'; } return $output; } /** * Flattens a multidimensional array to a simple array. * * @param array $array a multidimensional array. * * @return array a simple array */ public function flatten( $array ) { $result = array(); foreach ( $array as $element ) { if ( is_array( $element ) ) { array_push( $result, ...$this->flatten( $element ) ); } else { $result[] = $element; } } return $result; } } endif; |
Для 3-й версии Bootrstrap:
Другие варианты:
- MaterializeCSS Nav_Menu_Walker
- WP Mega-menu
- WordPress_Custom_Walker_Menu
- Bulma navbar-menu-walker
- WP BEM-walker/
- Category Aware_walker_nav_menu
Почитать дополнительно: