<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[46236] trunk/src/wp-includes/link-template.php: Accessibility: Make sure the navigation ARIA landmarks used for posts and comments navigation are properly labelled.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/46236">46236</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/46236","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>afercia</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-22 22:31:34 +0000 (Sun, 22 Sep 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Accessibility: Make sure the navigation ARIA landmarks used for posts and comments navigation are properly labelled.
The `<nav>` element defines an ARIA landmark by default: landmarks help assistive technology users to perceive the page main sections and jump through them. However, when a landmark is used more than once in a page, it needs to be distinguished from the other ones to let users understand what the landmark is about.
Adds an `aria-label` parameter to the following functions:
- `_navigation_markup()`
- `get_the_post_navigatio()`
- `get_the_posts_navigation()`
- `get_the_posts_pagination()`
- `get_the_comments_navigation()`
- `get_the_comments_pagination()`
Props sabernhardt, williampatton, SergeyBiryukov, audrasjb.
Fixes <a href="https://core.trac.wordpress.org/ticket/47123">#47123</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeslinktemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/link-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/link-template.php 2019-09-22 22:16:19 UTC (rev 46235)
+++ trunk/src/wp-includes/link-template.php 2019-09-22 22:31:34 UTC (rev 46236)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2544,6 +2544,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 Introduced the `in_same_term`, `excluded_terms`, and `taxonomy` arguments.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Added the `aria_label` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Default post navigation arguments. Default empty array.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2553,11 +2554,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $in_same_term Whether link should be in a same taxonomy term. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $excluded_terms Array or comma-separated list of excluded term IDs. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $taxonomy Taxonomy, if `$in_same_term` is true. Default 'category'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $screen_reader_text Screen reader text for nav element. Default 'Post navigation'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $screen_reader_text Screen reader text for the nav element. Default 'Post navigation'.
+ * @type string $aria_label ARIA label text for the nav element. Default 'Posts'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Markup for post links.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_the_post_navigation( $args = array() ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+ if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+ $args['aria_label'] = $args['screen_reader_text'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args(
</span><span class="cx" style="display: block; padding: 0 10px"> $args,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2567,6 +2574,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'excluded_terms' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'taxonomy' => 'category',
</span><span class="cx" style="display: block; padding: 0 10px"> 'screen_reader_text' => __( 'Post navigation' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'aria_label' => __( 'Posts' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2590,7 +2598,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Only add markup if there's somewhere to navigate to.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $previous || $next ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $navigation = _navigation_markup( $previous . $next, 'post-navigation', $args['screen_reader_text'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $navigation = _navigation_markup( $previous . $next, 'post-navigation', $args['screen_reader_text'], $args['aria_label'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $navigation;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2612,6 +2620,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns the navigation to next/previous set of posts, when applicable.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Added the `aria_label` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Query $wp_query WordPress Query object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2622,8 +2631,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'Older posts'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $next_text Anchor text to display in the next posts link.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'Newer posts'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $screen_reader_text Screen reader text for nav element.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $screen_reader_text Screen reader text for the nav element.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default 'Posts navigation'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $aria_label ARIA label text for the nav element. Default 'Posts'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Markup for posts links.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2632,6 +2642,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Don't print empty markup if there's only one page.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+ if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+ $args['aria_label'] = $args['screen_reader_text'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args(
</span><span class="cx" style="display: block; padding: 0 10px"> $args,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2638,6 +2653,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'prev_text' => __( 'Older posts' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'next_text' => __( 'Newer posts' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'screen_reader_text' => __( 'Posts navigation' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'aria_label' => __( 'Posts' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2652,7 +2668,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $navigation .= '<div class="nav-next">' . $next_link . '</div>';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $navigation = _navigation_markup( $navigation, 'posts-navigation', $args['screen_reader_text'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $navigation = _navigation_markup( $navigation, 'posts-navigation', $args['screen_reader_text'], $args['aria_label'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $navigation;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2674,6 +2690,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves a paginated navigation to next/previous set of posts, when applicable.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Added the `aria_label` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Default pagination arguments, see paginate_links().
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2680,6 +2697,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $screen_reader_text Screen reader text for navigation element.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'Posts navigation'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $aria_label ARIA label text for the nav element. Default 'Posts'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Markup for pagination links.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2688,6 +2706,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Don't print empty markup if there's only one page.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+ if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+ $args['aria_label'] = $args['screen_reader_text'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args(
</span><span class="cx" style="display: block; padding: 0 10px"> $args,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2695,6 +2718,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'prev_text' => _x( 'Previous', 'previous set of posts' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'next_text' => _x( 'Next', 'next set of posts' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'screen_reader_text' => __( 'Posts navigation' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'aria_label' => __( 'Posts' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2707,7 +2731,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $links = paginate_links( $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $links ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $navigation = _navigation_markup( $links, 'pagination', $args['screen_reader_text'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $navigation = _navigation_markup( $links, 'pagination', $args['screen_reader_text'], $args['aria_label'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2730,20 +2754,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Wraps passed links in navigational markup.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Added the `aria_label` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $links Navigational links.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $class Optional. Custom class for nav element. Default: 'posts-navigation'.
- * @param string $screen_reader_text Optional. Screen reader text for nav element. Default: 'Posts navigation'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $class Optional. Custom class for the nav element. Default: 'posts-navigation'.
+ * @param string $screen_reader_text Optional. Screen reader text for the nav element. Default: 'Posts navigation'.
+ * @param string $aria_label Optional. ARIA label for the nav element. Default: same value as $screen_reader_text.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Navigation template tag.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '', $aria_label = '' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $screen_reader_text ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $screen_reader_text = __( 'Posts navigation' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $aria_label ) ) {
+ $aria_label = $screen_reader_text;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $template = '
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <nav class="navigation %1$s" role="navigation">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <nav class="navigation %1$s" role="navigation" aria-label="%4$s">
</ins><span class="cx" style="display: block; padding: 0 10px"> <h2 class="screen-reader-text">%2$s</h2>
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="nav-links">%3$s</div>
</span><span class="cx" style="display: block; padding: 0 10px"> </nav>';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2752,10 +2781,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the navigation markup template.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: The filtered template HTML must contain specifiers for the navigation
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * class (%1$s), the screen-reader-text value (%2$s), and placement of the
- * navigation links (%3$s):
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * class (%1$s), the screen-reader-text value (%2$s), placement of the navigation
+ * links (%3$s), and ARIA label text if screen-reader-text does not fit that (%4$s):
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * <nav class="navigation %1$s" role="navigation">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * <nav class="navigation %1$s" role="navigation" aria-label="%4$s">
</ins><span class="cx" style="display: block; padding: 0 10px"> * <h2 class="screen-reader-text">%2$s</h2>
</span><span class="cx" style="display: block; padding: 0 10px"> * <div class="nav-links">%3$s</div>
</span><span class="cx" style="display: block; padding: 0 10px"> * </nav>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2768,7 +2797,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $template = apply_filters( 'navigation_markup_template', $template, $class );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links, esc_html( $aria_label ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2977,6 +3006,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves navigation to next/previous set of comments, when applicable.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Added the `aria_label` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Default comments navigation arguments.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2985,7 +3015,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'Older comments'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $next_text Anchor text to display in the next comments link.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'Newer comments'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'.
+ * @type string $aria_label ARIA label text for the nav element. Default 'Comments'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Markup for comments links.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2994,6 +3025,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Are there comments to navigate through?
</span><span class="cx" style="display: block; padding: 0 10px"> if ( get_comment_pages_count() > 1 ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+ if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+ $args['aria_label'] = $args['screen_reader_text'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args(
</span><span class="cx" style="display: block; padding: 0 10px"> $args,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3000,6 +3036,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'prev_text' => __( 'Older comments' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'next_text' => __( 'Newer comments' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'screen_reader_text' => __( 'Comments navigation' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'aria_label' => __( 'Comments' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3014,7 +3051,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $navigation .= '<div class="nav-next">' . $next_link . '</div>';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $navigation = _navigation_markup( $navigation, 'comment-navigation', $args['screen_reader_text'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $navigation = _navigation_markup( $navigation, 'comment-navigation', $args['screen_reader_text'], $args['aria_label'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $navigation;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3035,6 +3072,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves a paginated navigation to next/previous set of comments, when applicable.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Added the `aria_label` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see paginate_comments_links()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3041,16 +3079,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Default pagination arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'.
+ * @type string $aria_label ARIA label text for the nav element. Default 'Comments'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Markup for pagination links.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_the_comments_pagination( $args = array() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $navigation = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $navigation = '';
+
+ // Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
+ if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
+ $args['aria_label'] = $args['screen_reader_text'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args(
</span><span class="cx" style="display: block; padding: 0 10px"> $args,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'screen_reader_text' => __( 'Comments navigation' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'aria_label' => __( 'Comments' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $args['echo'] = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3063,7 +3109,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $links = paginate_comments_links( $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $links ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $navigation = _navigation_markup( $links, 'comments-pagination', $args['screen_reader_text'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $navigation = _navigation_markup( $links, 'comments-pagination', $args['screen_reader_text'], $args['aria_label'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $navigation;
</span></span></pre>
</div>
</div>
</body>
</html>