WordPress : indiquer l’item actif d’un menu dans le code HTML

a-lire_wp-item-actif.md

WordPress : indiquer l’item actif d’un menu dans le code HTML

Ajout d’une alternative HTML à l’indication visuelle qu’un item est actif dans un menu.

La fonction ci-dessous ajoute un texte masqué hors écran pour indiquer aux personnes aveugles naviguant avec un lecteur d’écran quel item de menu est actif.

Copiez le code dans le fichier functions.php de votre thème ou de votre thème enfant.

Notes :

• Dans ce code, on utilise la classe CSS .sr-only créée par Gaël Poupard. Mais il est bien entendu possible de remplacer cette classe par toute autre classe CSS au fonctionnement similaire, du moment qu’elle laisse bien l’élément accessible aux lecteurs d’écran (par opposition à la propriété display:none par exemple. Plus d’informations à ce sujet : Liens d’accès rapide – Fiche 2 : Navigation – Guide de l'intégrateur RGAA 3).

Inconvénient de cette technique

Ce texte masqué n’est accessible qu’aux personnes utilisant un lecteur d’écran pour consulter la page. Ajouter un attribut title sur le lien actif rendrait l’information accessible que l’on utilise un lecteur d’écran ou pas.

Autres solutions possibles

D’autres solutions sont également possibles pour indiquer l’élément actif de manière accessible.

À noter : dans Twenty Nineteen 1.4, l’item actif est indiqué avec l’attribut ARIA aria-current="page", ce qui comporte le même inconvénient que la méthode du texte masqué hors écran. En outre, cet attribut pose souci avec VoiceOver et VoiceAssistant a priori.

Références

• RGAA 4 :
  • Critère 3.1. Dans chaque page web, l’information ne doit pas être donnée uniquement par la couleur. Cette règle est-elle respectée ?
  • Critère 10.9 Dans chaque page web, l’information ne doit pas être donnée uniquement par la forme, taille ou position. Cette règle est-elle respectée ?
  • Critère 10.10. Dans chaque page web, l’information ne doit pas être donnée par la forme, taille ou position uniquement. Cette règle est-elle implémentée de façon pertinente ?
• WCAG 2.1 :
  • Success Criterion 2.4.8 Location (AAA)

Licence

Code distribué sous la licence GPLv2 ou ultérieure. En savoir plus sur la licence de WordPress.

En savoir plus

Conférence « Comment améliorer l’accessibilité de votre thème WordPress ? » de Marie Guillaumet.

functions.php

<?php

/**
 * Add HTML suffix to nav active items in the main nav
 */
class a42_active_item_walker extends Walker_Nav_Menu
{
	// Function responsible for the opening <li> tag and the link 
	function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
		
		$is_current_item = '';
		$is_current_item_class = '';

		// Replace 'twentynineteen' by your own text domain
		global $text_domain; if (!$text_domain && !isset($text_domain)) $text_domain = 'twentynineteen';

		// Get item classes
		$total = count($item->classes);
		$i = 0;

		// Loop through each class to display them accordingly
		foreach ($item->classes as $item_class){
			$is_current_item_class .= $item_class;

			// Insert white spaces if needed
			if ($i > 0 && $i != $total - 1) :
				$is_current_item_class .= ' ';
			endif;

			$i++;
		}

		// Add HTML in the active item
		if(array_search('current-menu-item', $item->classes) != 0)
		{
			$is_current_item = '<span class="sr-only">' . __(' – active page', $text_domain) . '</span>';
		}

		// Output result
		$output .= '<li class="'.$is_current_item_class.'"><a href="'.$item->url.'">'.$item->title . $is_current_item;
	}

	// Function responsible for the closing </li> tag is end_el
	function end_el( &$output, $item, $depth = 0, $args = array() ) {
		$output .= '</a></li>';
	}
}