Changeset 41371

Timestamp:

09/11/2017 02:28:59 PM (7 years ago)

Author:

afercia

Message:

Allow usage of aria-current in paginate_links().

The aria-current attribute is a simple, effective way to help assistive
technology users orientate themselves within a list of items.

Props GrahamArmfield, palmiak.
Fixes #40833.

Location:

trunk

Files:

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

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

@@ -3262 +3262 @@
  *
  * @since 2.1.0
+ * @since 4.9.0 Added the `aria_current` argument.
  *
  * @global WP_Query   $wp_query
@@ -3274 +3275 @@
  *                                      `max_num_pages` or 1.
  *     @type int    $current            The current page number. Default is 'paged' query var or 1.
+ *     @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 bool   $show_all           Whether to show all pages. Default false.
  *     @type int    $end_size           How many numbers on either the start and the end list edges.
@@ -3309 +3312 @@
 
     $defaults = array(
-        'base' => $pagenum_link, // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
-        'format' => $format, // ?page=%#% : %#% is replaced by the page number
-        'total' => $total,
-        'current' => $current,
-        'show_all' => false,
-        'prev_next' => true,
-        'prev_text' => __('« Previous'),
-        'next_text' => __('Next »'),
-        'end_size' => 1,
-        'mid_size' => 2,
-        'type' => 'plain',
-        'add_args' => array(), // array of query args to add
-        'add_fragment' => '',
+        'base'               => $pagenum_link, // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
+        'format'             => $format, // ?page=%#% : %#% is replaced by the page number
+        'total'              => $total,
+        'current'            => $current,
+        'aria_current'       => 'page',
+        'show_all'           => false,
+        'prev_next'          => true,
+        'prev_text'          => __( '« Previous' ),
+        'next_text'          => __( 'Next »' ),
+        'end_size'           => 1,
+        'mid_size'           => 2,
+        'type'               => 'plain',
+        'add_args'           => array(), // array of query args to add
+        'add_fragment'       => '',
         'before_page_number' => '',
-        'after_page_number' => ''
+        'after_page_number'  => '',
     );
 
@@ -3387 +3391 @@
     for ( $n = 1; $n <= $total; $n++ ) :
         if ( $n == $current ) :
-            $page_links[] = "<span class='page-numbers current'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</span>";
+            $page_links[] = "<span aria-current='" . esc_attr( $args['aria_current'] ) . "' class='page-numbers current'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</span>";
             $dots = true;
         else :

trunk/tests/phpunit/tests/general/paginateLinks.php

@@ -17 +17 @@
 
         $expected =<<<EXPECTED
-<span class='page-numbers current'>1</span>
+<span aria-current='page' class='page-numbers current'>1</span>
 <a class='page-numbers' href='$page2'>2</a>
 <a class='page-numbers' href='$page3'>3</a>
@@ -35 +35 @@
 
         $expected =<<<EXPECTED
-<span class='page-numbers current'>1</span>
+<span aria-current='page' class='page-numbers current'>1</span>
 <a class='page-numbers' href='$page2'>2</a>
 <a class='page-numbers' href='$page3'>3</a>
@@ -55 +55 @@
         $expected =<<<EXPECTED
 <a class='page-numbers' href='$home'>1</a>
-<span class='page-numbers current'>2</span>
+<span aria-current='page' class='page-numbers current'>2</span>
 <a class='page-numbers' href='$page3'>3</a>
 <a class='page-numbers' href='$page4'>4</a>
@@ -75 +75 @@
 <a class="prev page-numbers" href="$home">&laquo; Previous</a>
 <a class='page-numbers' href='$home'>1</a>
-<span class='page-numbers current'>2</span>
+<span aria-current='page' class='page-numbers current'>2</span>
 <a class='page-numbers' href='$page3'>3</a>
 <a class='page-numbers' href='$page4'>4</a>
@@ -300 +300 @@
         ) );
 
-        $this->assertContains( "<span class='page-numbers current'>3</span>", $links );
+        $this->assertContains( "<span aria-current='page' class='page-numbers current'>3</span>", $links );
     }