WordPress/wp-admin/menu-header.php
desrosj 04c8217724 Administration: Add the aria-hidden attribute to admin menu icons.
The admin menu icons are included as a visual element to support the text links. Without the `aria-hidden=“true”` attribute, they are also exposed to assistive technologies (which can process icon fonts in unpredictable ways).

This change improves the experience for multiple types of assistive technologies, including screen reading and voice control software. With `aria-hidden=“true”` added, the icons will not be read, and a user can now trigger a click of a top level admin menu item with commands such as “click posts”, or “click plugins”.

Props joedolson, afercia, audrasjb, adriantirusli.
Fixes #51012.
Built from https://develop.svn.wordpress.org/trunk@48963


git-svn-id: http://core.svn.wordpress.org/trunk@48725 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-09-09 16:15:06 +00:00

307 lines
9.7 KiB
PHP

<?php
/**
* Displays Administration Menu.
*
* @package WordPress
* @subpackage Administration
*/
/**
* The current page.
*
* @global string $self
*/
$self = preg_replace( '|^.*/wp-admin/network/|i', '', $_SERVER['PHP_SELF'] );
$self = preg_replace( '|^.*/wp-admin/|i', '', $self );
$self = preg_replace( '|^.*/plugins/|i', '', $self );
$self = preg_replace( '|^.*/mu-plugins/|i', '', $self );
/**
* For when admin-header is included from within a function.
*
* @global array $menu
* @global array $submenu
* @global string $parent_file
* @global string $submenu_file
*/
global $menu, $submenu, $parent_file, $submenu_file;
/**
* Filters the parent file of an admin menu sub-menu item.
*
* Allows plugins to move sub-menu items around.
*
* @since MU (3.0.0)
*
* @param string $parent_file The parent file.
*/
$parent_file = apply_filters( 'parent_file', $parent_file );
/**
* Filters the file of an admin menu sub-menu item.
*
* @since 4.4.0
*
* @param string $submenu_file The submenu file.
* @param string $parent_file The submenu item's parent file.
*/
$submenu_file = apply_filters( 'submenu_file', $submenu_file, $parent_file );
get_admin_page_parent();
/**
* Display menu.
*
* @access private
* @since 2.7.0
*
* @global string $self
* @global string $parent_file
* @global string $submenu_file
* @global string $plugin_page
* @global string $typenow
*
* @param array $menu
* @param array $submenu
* @param bool $submenu_as_parent
*/
function _wp_menu_output( $menu, $submenu, $submenu_as_parent = true ) {
global $self, $parent_file, $submenu_file, $plugin_page, $typenow;
$first = true;
// 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes, 5 = hookname, 6 = icon_url.
foreach ( $menu as $key => $item ) {
$admin_is_parent = false;
$class = array();
$aria_attributes = '';
$aria_hidden = '';
$is_separator = false;
if ( $first ) {
$class[] = 'wp-first-item';
$first = false;
}
$submenu_items = array();
if ( ! empty( $submenu[ $item[2] ] ) ) {
$class[] = 'wp-has-submenu';
$submenu_items = $submenu[ $item[2] ];
}
if ( ( $parent_file && $item[2] === $parent_file ) || ( empty( $typenow ) && $self === $item[2] ) ) {
if ( ! empty( $submenu_items ) ) {
$class[] = 'wp-has-current-submenu wp-menu-open';
} else {
$class[] = 'current';
$aria_attributes .= 'aria-current="page"';
}
} else {
$class[] = 'wp-not-current-submenu';
if ( ! empty( $submenu_items ) ) {
$aria_attributes .= 'aria-haspopup="true"';
}
}
if ( ! empty( $item[4] ) ) {
$class[] = esc_attr( $item[4] );
}
$class = $class ? ' class="' . join( ' ', $class ) . '"' : '';
$id = ! empty( $item[5] ) ? ' id="' . preg_replace( '|[^a-zA-Z0-9_:.]|', '-', $item[5] ) . '"' : '';
$img = '';
$img_style = '';
$img_class = ' dashicons-before';
if ( false !== strpos( $class, 'wp-menu-separator' ) ) {
$is_separator = true;
}
/*
* If the string 'none' (previously 'div') is passed instead of a URL, don't output
* the default menu image so an icon can be added to div.wp-menu-image as background
* with CSS. Dashicons and base64-encoded data:image/svg_xml URIs are also handled
* as special cases.
*/
if ( ! empty( $item[6] ) ) {
$img = '<img src="' . $item[6] . '" alt="" />';
if ( 'none' === $item[6] || 'div' === $item[6] ) {
$img = '<br />';
} elseif ( 0 === strpos( $item[6], 'data:image/svg+xml;base64,' ) ) {
$img = '<br />';
$img_style = ' style="background-image:url(\'' . esc_attr( $item[6] ) . '\')"';
$img_class = ' svg';
} elseif ( 0 === strpos( $item[6], 'dashicons-' ) ) {
$img = '<br />';
$img_class = ' dashicons-before ' . sanitize_html_class( $item[6] );
}
}
$arrow = '<div class="wp-menu-arrow"><div></div></div>';
$title = wptexturize( $item[0] );
// Hide separators from screen readers.
if ( $is_separator ) {
$aria_hidden = ' aria-hidden="true"';
}
echo "\n\t<li$class$id$aria_hidden>";
if ( $is_separator ) {
echo '<div class="separator"></div>';
} elseif ( $submenu_as_parent && ! empty( $submenu_items ) ) {
$submenu_items = array_values( $submenu_items ); // Re-index.
$menu_hook = get_plugin_page_hook( $submenu_items[0][2], $item[2] );
$menu_file = $submenu_items[0][2];
$pos = strpos( $menu_file, '?' );
if ( false !== $pos ) {
$menu_file = substr( $menu_file, 0, $pos );
}
if ( ! empty( $menu_hook )
|| ( ( 'index.php' !== $submenu_items[0][2] )
&& file_exists( WP_PLUGIN_DIR . "/$menu_file" )
&& ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) )
) {
$admin_is_parent = true;
echo "<a href='admin.php?page={$submenu_items[0][2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style aria-hidden='true'>$img</div><div class='wp-menu-name'>$title</div></a>";
} else {
echo "\n\t<a href='{$submenu_items[0][2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style aria-hidden='true'>$img</div><div class='wp-menu-name'>$title</div></a>";
}
} elseif ( ! empty( $item[2] ) && current_user_can( $item[1] ) ) {
$menu_hook = get_plugin_page_hook( $item[2], 'admin.php' );
$menu_file = $item[2];
$pos = strpos( $menu_file, '?' );
if ( false !== $pos ) {
$menu_file = substr( $menu_file, 0, $pos );
}
if ( ! empty( $menu_hook )
|| ( ( 'index.php' !== $item[2] )
&& file_exists( WP_PLUGIN_DIR . "/$menu_file" )
&& ! file_exists( ABSPATH . "/wp-admin/$menu_file" ) )
) {
$admin_is_parent = true;
echo "\n\t<a href='admin.php?page={$item[2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style aria-hidden='true'>$img</div><div class='wp-menu-name'>{$item[0]}</div></a>";
} else {
echo "\n\t<a href='{$item[2]}'$class $aria_attributes>$arrow<div class='wp-menu-image$img_class'$img_style aria-hidden='true'>$img</div><div class='wp-menu-name'>{$item[0]}</div></a>";
}
}
if ( ! empty( $submenu_items ) ) {
echo "\n\t<ul class='wp-submenu wp-submenu-wrap'>";
echo "<li class='wp-submenu-head' aria-hidden='true'>{$item[0]}</li>";
$first = true;
// 0 = menu_title, 1 = capability, 2 = menu_slug, 3 = page_title, 4 = classes.
foreach ( $submenu_items as $sub_key => $sub_item ) {
if ( ! current_user_can( $sub_item[1] ) ) {
continue;
}
$class = array();
$aria_attributes = '';
if ( $first ) {
$class[] = 'wp-first-item';
$first = false;
}
$menu_file = $item[2];
$pos = strpos( $menu_file, '?' );
if ( false !== $pos ) {
$menu_file = substr( $menu_file, 0, $pos );
}
// Handle current for post_type=post|page|foo pages, which won't match $self.
$self_type = ! empty( $typenow ) ? $self . '?post_type=' . $typenow : 'nothing';
if ( isset( $submenu_file ) ) {
if ( $submenu_file === $sub_item[2] ) {
$class[] = 'current';
$aria_attributes .= ' aria-current="page"';
}
// If plugin_page is set the parent must either match the current page or not physically exist.
// This allows plugin pages with the same hook to exist under different parents.
} elseif (
( ! isset( $plugin_page ) && $self === $sub_item[2] )
|| ( isset( $plugin_page ) && $plugin_page === $sub_item[2]
&& ( $item[2] === $self_type || $item[2] === $self || file_exists( $menu_file ) === false ) )
) {
$class[] = 'current';
$aria_attributes .= ' aria-current="page"';
}
if ( ! empty( $sub_item[4] ) ) {
$class[] = esc_attr( $sub_item[4] );
}
$class = $class ? ' class="' . join( ' ', $class ) . '"' : '';
$menu_hook = get_plugin_page_hook( $sub_item[2], $item[2] );
$sub_file = $sub_item[2];
$pos = strpos( $sub_file, '?' );
if ( false !== $pos ) {
$sub_file = substr( $sub_file, 0, $pos );
}
$title = wptexturize( $sub_item[0] );
if ( ! empty( $menu_hook )
|| ( ( 'index.php' !== $sub_item[2] )
&& file_exists( WP_PLUGIN_DIR . "/$sub_file" )
&& ! file_exists( ABSPATH . "/wp-admin/$sub_file" ) )
) {
// If admin.php is the current page or if the parent exists as a file in the plugins or admin directory.
if ( ( ! $admin_is_parent && file_exists( WP_PLUGIN_DIR . "/$menu_file" ) && ! is_dir( WP_PLUGIN_DIR . "/{$item[2]}" ) ) || file_exists( $menu_file ) ) {
$sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), $item[2] );
} else {
$sub_item_url = add_query_arg( array( 'page' => $sub_item[2] ), 'admin.php' );
}
$sub_item_url = esc_url( $sub_item_url );
echo "<li$class><a href='$sub_item_url'$class$aria_attributes>$title</a></li>";
} else {
echo "<li$class><a href='{$sub_item[2]}'$class$aria_attributes>$title</a></li>";
}
}
echo '</ul>';
}
echo '</li>';
}
echo '<li id="collapse-menu" class="hide-if-no-js">' .
'<button type="button" id="collapse-button" aria-label="' . esc_attr__( 'Collapse Main menu' ) . '" aria-expanded="true">' .
'<span class="collapse-button-icon" aria-hidden="true"></span>' .
'<span class="collapse-button-label">' . __( 'Collapse menu' ) . '</span>' .
'</button></li>';
}
?>
<div id="adminmenumain" role="navigation" aria-label="<?php esc_attr_e( 'Main menu' ); ?>">
<a href="#wpbody-content" class="screen-reader-shortcut"><?php _e( 'Skip to main content' ); ?></a>
<a href="#wp-toolbar" class="screen-reader-shortcut"><?php _e( 'Skip to toolbar' ); ?></a>
<div id="adminmenuback"></div>
<div id="adminmenuwrap">
<ul id="adminmenu">
<?php
_wp_menu_output( $menu, $submenu );
/**
* Fires after the admin menu has been output.
*
* @since 2.5.0
*/
do_action( 'adminmenu' );
?>
</ul>
</div>
</div>