Changeset 34891 for trunk/src/wp-admin/includes/class-wp-screen.php

Timestamp:

10/07/2015 01:27:01 AM (9 years ago)

Author:

wonderboymusic

Message:

List Tables/WP_Screen: in WP_Screen, add methods to store, retrieve, and render screen reader text, primarily used by list table screens.

These additions are based on an audit and recommendations by the Accessibility team. #a11y'all

Props afercia.
Fixes #32147.

File:

• trunk/src/wp-admin/includes/class-wp-screen.php (modified) (3 diffs)

trunk/src/wp-admin/includes/class-wp-screen.php

@@ -142 +142 @@
      */
     private $_help_sidebar = '';
+
+    /**
+     * The accessible hidden headings and text associated with the screen, if any.
+     *
+     * @since 4.4.0
+     * @access private
+     * @var array
+     */
+    private $_screen_reader_content = array();
 
     /**
@@ -643 +652 @@
     public function get_columns() {
         return $this->columns;
+    }
+
+    /**
+     * Get the accessible hidden headings and text used in the screen.
+     *
+     * @since 4.4.0
+     *
+     * @see set_screen_reader_content() For more information on the array format.
+     *
+     * @return array An associative array of screen reader text strings.
+     */
+    public function get_screen_reader_content() {
+        return $this->_screen_reader_content;
+    }
+
+    /**
+     * Get a screen reader text string.
+     *
+     * @since 4.4.0
+     *
+     * @param string $key Screen reader text array named key.
+     * @return string Screen reader text string.
+     */
+    public function get_screen_reader_text( $key ) {
+        if ( ! isset( $this->_screen_reader_content[ $key ] ) ) {
+            return null;
+        }
+        return $this->_screen_reader_content[ $key ];
+    }
+
+    /**
+     * Add accessible hidden headings and text for the screen.
+     *
+     * @since 4.4.0
+     *
+     * @param array $content {
+     *     An associative array of screen reader text strings.
+     *
+     *     @type string $heading_views      Screen reader text for the filter links heading.
+     *                                      Default 'Filter items list'.
+     *     @type string $heading_pagination Screen reader text for the pagination heading.
+     *                                      Default 'Items list navigation'.
+     *     @type string heading_list        Screen reader text for the items list heading.
+     *                                      Default 'Items list'.
+     * }
+     */
+    public function set_screen_reader_content( $content = array() ) {
+        $defaults = array(
+            'heading_views'      => __( 'Filter items list' ),
+            'heading_pagination' => __( 'Items list navigation' ),
+            'heading_list'       => __( 'Items list' ),
+        );
+        $content = wp_parse_args( $content, $defaults );
+
+        $this->_screen_reader_content = $content;
+    }
+
+    /**
+     * Remove all the accessible hidden headings and text for the screen.
+     *
+     * @since 4.4.0
+     */
+    public function remove_screen_reader_content() {
+        $this->_screen_reader_content = array();
     }
 
@@ -1065 +1138 @@
         <?php
     }
+
+    /**
+     * Render screen reader text.
+     *
+     * @since 4.4.0
+     *
+     * @param string $key The screen reader text array named key.
+     * @param string $tag Optional. The HTML tag to wrap the screen reader text. Default h2.
+     */
+    public function render_screen_reader_content( $key = '', $tag = 'h2' ) {
+
+        if ( ! isset( $this->_screen_reader_content[ $key ] ) ) {
+            return;
+        }
+        echo "<$tag class='screen-reader-text'>" . $this->_screen_reader_content[ $key ] . "</$tag>";
+    }
 }