proteusthemes/wai-aria-walker-nav-menu

WordPress menu walker which adds appropriate WIA-ARIA roles to dropdown menus.

WAI-ARIA WordPress Walker

Nav menu walker for WP with correct WAI-ARIA roles for dropdown menus., _(*1)

Install

Detailed explanation in a blogpost., _(*2)

1. You can install this class using Composer (preferred method) or manually copying this file to your theme / project., _(*3)

2. After that, include it in your theme, probably something like (assuming you installed it using Composer):, _(*4)

   require_once 'vendor/proteusthemes/wai-aria-walker-nav-menu/aria-walker-nav-menu.php';
   

   You must enqueue wai-aria.js as well, because the aria-expanded attributes needs to be updated with JS., _(*5)

3. Finally, include the menus in your theme files as per example below:, _(*6)

   <nav class="collapse  navbar-collapse" role="navigation" aria-label="<?php _e( 'Main Menu', 'your-textdomain' ); ?>">
   <?php
       if ( has_nav_menu( 'your-menu' ) ) {
           wp_nav_menu( array(
               'theme_location' => 'your-menu',
               'container'      => false,
               'menu_class'     => 'main-navigation',
               'walker'         => new Aria_Walker_Nav_Menu(),
               'items_wrap'     => '<ul id="%1$s" class="%2$s">%3$s</ul>',
           ) );
       }
   ?>
   </nav>
   

   Mind:, _(*7)

• 'walker' => new Aria_Walker_Nav_Menu(),
• <nav> wrapping element and 'container' => false in the arguments
• role="navigation"
• aria-label="<?php _e( 'Main Menu', 'your-textdomain' ); ?>"
• 'items_wrap' => '<ul id="%1$s" class="%2$s">%3$s</ul>',

Compatibility with WP

This repo aims to be 1:1 compatible with latest WP version, mainly with the class Walker_Nav_Menu in the file /<path-to-wp>/wp-includes/nav-menu-template.php., _(*8)

Current version is compatible with WP core 4.5., _(*9)

Contributing

No need to explain - fork me and create a pull request., _(*10)

Created by @primozcigler and @Prelc.