Changeset 42440

Timestamp:

01/12/2018 08:16:56 PM (7 years ago)

Author:

afercia

Message:

Accessibility: use aria-current for the paginated post links output by wp_link_pages().

Continues the introduction in core of the aria-current attribute after [41683], [41359], and [41371].

• changes the wp_link_pages() (see the nextpage quicktag) output to use an aria-current attribute on the current item
• adds post-nav-links and post-page-numbers CSS classes to help themes style these links
• updates the related tests

Props antonioeatgoat, alexstine.
Fixes #41859.

Location:

trunk

Files:

• src/wp-includes/post-template.php (modified) (5 diffs)
• tests/phpunit/tests/post/template.php (modified) (5 diffs)

trunk/src/wp-includes/post-template.php

@@ -863 +863 @@
  *
  * @since 1.2.0
+ * @since 5.0.0 Added the `aria_current` argument.
  *
  * @global int $page
@@ -878 +879 @@
  *     @type string       $link_after       HTML or text to append to each Pages link inside the `<a>` tag.
  *                                          Also appended to the current item, which is not linked. Default empty.
+ *     @type string       $aria_current     The value for the aria-current attribute. Possible values are 'page',
+ *                                          'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'.
  *     @type string       $next_or_number   Indicates whether page numbers should be used. Valid values are number
  *                                          and next. Default is 'number'.
@@ -894 +897 @@
 
     $defaults = array(
-        'before'           => '<p>' . __( 'Pages:' ),
+        'before'           => '<p class="post-nav-links">' . __( 'Pages:' ),
         'after'            => '</p>',
         'link_before'      => '',
         'link_after'       => '',
+        'aria_current'     => 'page',
         'next_or_number'   => 'number',
         'separator'        => ' ',
@@ -925 +929 @@
                 if ( $i != $page || ! $more && 1 == $page ) {
                     $link = _wp_link_page( $i ) . $link . '</a>';
+                } elseif ( $i === $page ) {
+                    $link = '<span class="post-page-numbers current" aria-current="' . esc_attr( $r['aria_current'] ) . '">' . $link . '</span>';
                 }
                 /**
@@ -1018 +1024 @@
     }
 
-    return '<a href="' . esc_url( $url ) . '">';
+    return '<a href="' . esc_url( $url ) . '" class="post-page-numbers">';
 }
 

trunk/tests/phpunit/tests/post/template.php

@@ -15 +15 @@
         setup_postdata( get_post( $post_id ) );
 
-        $permalink = sprintf( '<a href="%s">', get_permalink() );
+        $permalink = sprintf( '<a href="%s" class="post-page-numbers">', get_permalink() );
         $page2     = _wp_link_page( 2 );
         $page3     = _wp_link_page( 3 );
 
-        $expected = "<p>Pages: 1 {$page2}2</a> {$page3}3</a></p>";
+        $expected = '<p class="post-nav-links">Pages: <span class="post-page-numbers current" aria-current="page">1</span> ' . $page2 . '2</a> ' . $page3 . '3</a></p>';
         $output   = wp_link_pages( array( 'echo' => 0 ) );
 
         $this->assertEquals( $expected, $output );
 
-        $before_after = " 1 {$page2}2</a> {$page3}3</a>";
+        $before_after = " <span class=\"post-page-numbers current\" aria-current=\"page\">1</span> {$page2}2</a> {$page3}3</a>";
         $output       = wp_link_pages(
             array(
@@ -35 +35 @@
         $this->assertEquals( $before_after, $output );
 
-        $separator = " 1{$page2}2</a>{$page3}3</a>";
+        $separator = " <span class=\"post-page-numbers current\" aria-current=\"page\">1</span>{$page2}2</a>{$page3}3</a>";
         $output    = wp_link_pages(
             array(
@@ -47 +47 @@
         $this->assertEquals( $separator, $output );
 
-        $link   = " <em>1</em>{$page2}<em>2</em></a>{$page3}<em>3</em></a>";
+        $link   = " <span class=\"post-page-numbers current\" aria-current=\"page\"><em>1</em></span>{$page2}<em>2</em></a>{$page3}<em>3</em></a>";
         $output = wp_link_pages(
             array(
@@ -108 +108 @@
 
         $GLOBALS['page'] = 1;
-        $separator       = "<p>Pages: 1 | {$page2}2</a> | {$page3}3</a></p>";
+        $separator       = "<p class=\"post-nav-links\">Pages: <span class=\"post-page-numbers current\" aria-current=\"page\">1</span> | {$page2}2</a> | {$page3}3</a></p>";
         $output          = wp_link_pages(
             array(
@@ -118 +118 @@
         $this->assertEquals( $separator, $output );
 
-        $pagelink = " Page 1 | {$page2}Page 2</a> | {$page3}Page 3</a>";
+        $pagelink = " <span class=\"post-page-numbers current\" aria-current=\"page\">Page 1</span> | {$page2}Page 2</a> | {$page3}Page 3</a>";
         $output   = wp_link_pages(
             array(