WordPress 4.7
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-list-table.php
index ad35fc670a3559f7b8a4b868810f8d2389e55dcf..bf642acb2572d9ab52e0de6f8695c9d50e3910a4 100644 (file)
@@ -1,65 +1,71 @@
 <?php
+/**
+ * Administration API: WP_List_Table class
+ *
+ * @package WordPress
+ * @subpackage List_Table
+ * @since 3.1.0
+ */
+
 /**
  * Base class for displaying a list of items in an ajaxified HTML table.
  *
  * @since 3.1.0
  * @access private
- *
- * @package WordPress
- * @subpackage List_Table
  */
 class WP_List_Table {
 
        /**
-        * The current list of items
+        * The current list of items.
         *
         * @since 3.1.0
-        * @var array
         * @access public
+        * @var array
         */
        public $items;
 
        /**
-        * Various information about the current table
+        * Various information about the current table.
         *
         * @since 3.1.0
-        * @var array
         * @access protected
+        * @var array
         */
        protected $_args;
 
        /**
-        * Various information needed for displaying the pagination
+        * Various information needed for displaying the pagination.
         *
         * @since 3.1.0
+        * @access protected
         * @var array
         */
        protected $_pagination_args = array();
 
        /**
-        * The current screen
+        * The current screen.
         *
         * @since 3.1.0
-        * @var object
         * @access protected
+        * @var object
         */
        protected $screen;
 
        /**
-        * Cached bulk actions
+        * Cached bulk actions.
         *
         * @since 3.1.0
-        * @var array
         * @access private
+        * @var array
         */
        private $_actions;
 
        /**
-        * Cached pagination output
+        * Cached pagination output.
         *
         * @since 3.1.0
-        * @var string
         * @access private
+        * @var string
         */
        private $_pagination;
 
@@ -67,20 +73,34 @@ class WP_List_Table {
         * The view switcher modes.
         *
         * @since 4.1.0
-        * @var array
         * @access protected
+        * @var array
         */
        protected $modes = array();
 
        /**
-        * Stores the value returned by ->get_column_info()
+        * Stores the value returned by ->get_column_info().
         *
+        * @since 4.1.0
+        * @access protected
         * @var array
         */
        protected $_column_headers;
 
+       /**
+        * {@internal Missing Summary}
+        *
+        * @access protected
+        * @var array
+        */
        protected $compat_fields = array( '_args', '_pagination_args', 'screen', '_actions', '_pagination' );
 
+       /**
+        * {@internal Missing Summary}
+        *
+        * @access protected
+        * @var array
+        */
        protected $compat_methods = array( 'set_pagination_args', 'get_views', 'get_bulk_actions', 'bulk_actions',
                'row_actions', 'months_dropdown', 'view_switcher', 'comments_bubble', 'get_items_per_page', 'pagination',
                'get_sortable_columns', 'get_column_info', 'get_table_classes', 'display_tablenav', 'extra_tablenav',
@@ -103,10 +123,10 @@ class WP_List_Table {
         *                            in the list table, e.g. 'posts'. Default empty.
         *     @type string $singular Singular label for an object being listed, e.g. 'post'.
         *                            Default empty
-        *     @type bool   $ajax     Whether the list table supports AJAX. This includes loading
+        *     @type bool   $ajax     Whether the list table supports Ajax. This includes loading
         *                            and sorting data, for example. If true, the class will call
-        *                            the {@see _js_vars()} method in the footer to provide variables
-        *                            to any scripts handling AJAX events. Default false.
+        *                            the _js_vars() method in the footer to provide variables
+        *                            to any scripts handling Ajax events. Default false.
         *     @type string $screen   String containing the hook name used to determine the current
         *                            screen. If left null, the current screen will be automatically set.
         *                            Default null.
@@ -146,7 +166,7 @@ class WP_List_Table {
        }
 
        /**
-        * Make private properties readable for backwards compatibility.
+        * Make private properties readable for backward compatibility.
         *
         * @since 4.0.0
         * @access public
@@ -161,7 +181,7 @@ class WP_List_Table {
        }
 
        /**
-        * Make private properties settable for backwards compatibility.
+        * Make private properties settable for backward compatibility.
         *
         * @since 4.0.0
         * @access public
@@ -177,7 +197,7 @@ class WP_List_Table {
        }
 
        /**
-        * Make private properties checkable for backwards compatibility.
+        * Make private properties checkable for backward compatibility.
         *
         * @since 4.0.0
         * @access public
@@ -192,7 +212,7 @@ class WP_List_Table {
        }
 
        /**
-        * Make private properties un-settable for backwards compatibility.
+        * Make private properties un-settable for backward compatibility.
         *
         * @since 4.0.0
         * @access public
@@ -206,7 +226,7 @@ class WP_List_Table {
        }
 
        /**
-        * Make private/protected methods readable for backwards compatibility.
+        * Make private/protected methods readable for backward compatibility.
         *
         * @since 4.0.0
         * @access public
@@ -248,10 +268,10 @@ class WP_List_Table {
        /**
         * An internal method that sets all the necessary pagination arguments
         *
-        * @param array $args An associative array with information about the pagination
+        * @since 3.1.0
         * @access protected
         *
-        * @param array|string $args
+        * @param array|string $args Array or string of arguments with information about the pagination.
         */
        protected function set_pagination_args( $args ) {
                $args = wp_parse_args( $args, array(
@@ -264,7 +284,7 @@ class WP_List_Table {
                        $args['total_pages'] = ceil( $args['total_items'] / $args['per_page'] );
 
                // Redirect if page number is invalid and headers are not already sent.
-               if ( ! headers_sent() && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) && $args['total_pages'] > 0 && $this->get_pagenum() > $args['total_pages'] ) {
+               if ( ! headers_sent() && ! wp_doing_ajax() && $args['total_pages'] > 0 && $this->get_pagenum() > $args['total_pages'] ) {
                        wp_redirect( add_query_arg( 'paged', $args['total_pages'] ) );
                        exit;
                }
@@ -283,11 +303,13 @@ class WP_List_Table {
         * @return int Number of items that correspond to the given pagination argument.
         */
        public function get_pagination_arg( $key ) {
-               if ( 'page' == $key )
+               if ( 'page' === $key ) {
                        return $this->get_pagenum();
+               }
 
-               if ( isset( $this->_pagination_args[$key] ) )
+               if ( isset( $this->_pagination_args[$key] ) ) {
                        return $this->_pagination_args[$key];
+               }
        }
 
        /**
@@ -313,13 +335,13 @@ class WP_List_Table {
        }
 
        /**
-        * Display the search box.
+        * Displays the search box.
         *
         * @since 3.1.0
         * @access public
         *
-        * @param string $text The search button text
-        * @param string $input_id The search input id
+        * @param string $text     The 'submit' button label.
+        * @param string $input_id ID attribute value for the search input field.
         */
        public function search_box( $text, $input_id ) {
                if ( empty( $_REQUEST['s'] ) && !$this->has_items() )
@@ -337,9 +359,9 @@ class WP_List_Table {
                        echo '<input type="hidden" name="detached" value="' . esc_attr( $_REQUEST['detached'] ) . '" />';
 ?>
 <p class="search-box">
-       <label class="screen-reader-text" for="<?php echo $input_id ?>"><?php echo $text; ?>:</label>
-       <input type="search" id="<?php echo $input_id ?>" name="s" value="<?php _admin_search_query(); ?>" />
-       <?php submit_button( $text, 'button', '', false, array('id' => 'search-submit') ); ?>
+       <label class="screen-reader-text" for="<?php echo esc_attr( $input_id ); ?>"><?php echo $text; ?>:</label>
+       <input type="search" id="<?php echo esc_attr( $input_id ); ?>" name="s" value="<?php _admin_search_query(); ?>" />
+       <?php submit_button( $text, '', '', false, array( 'id' => 'search-submit' ) ); ?>
 </p>
 <?php
        }
@@ -366,7 +388,7 @@ class WP_List_Table {
        public function views() {
                $views = $this->get_views();
                /**
-                * Filter the list of available list table views.
+                * Filters the list of available list table views.
                 *
                 * The dynamic portion of the hook name, `$this->screen->id`, refers
                 * to the ID of the current screen, usually a string.
@@ -380,6 +402,8 @@ class WP_List_Table {
                if ( empty( $views ) )
                        return;
 
+               $this->screen->render_screen_reader_content( 'heading_views' );
+
                echo "<ul class='subsubsub'>\n";
                foreach ( $views as $class => $view ) {
                        $views[ $class ] = "\t<li class='$class'>$view";
@@ -408,13 +432,13 @@ class WP_List_Table {
         * @access protected
         *
         * @param string $which The location of the bulk actions: 'top' or 'bottom'.
-        *                      This is designated as optional for backwards-compatibility.
+        *                      This is designated as optional for backward compatibility.
         */
        protected function bulk_actions( $which = '' ) {
                if ( is_null( $this->_actions ) ) {
-                       $no_new_actions = $this->_actions = $this->get_bulk_actions();
+                       $this->_actions = $this->get_bulk_actions();
                        /**
-                        * Filter the list table Bulk Actions drop-down.
+                        * Filters the list table Bulk Actions drop-down.
                         *
                         * The dynamic portion of the hook name, `$this->screen->id`, refers
                         * to the ID of the current screen, usually a string.
@@ -426,7 +450,6 @@ class WP_List_Table {
                         * @param array $actions An array of the available bulk actions.
                         */
                        $this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions );
-                       $this->_actions = array_intersect_assoc( $this->_actions, $no_new_actions );
                        $two = '';
                } else {
                        $two = '2';
@@ -435,14 +458,14 @@ class WP_List_Table {
                if ( empty( $this->_actions ) )
                        return;
 
-               echo "<label for='bulk-action-selector-" . esc_attr( $which ) . "' class='screen-reader-text'>" . __( 'Select bulk action' ) . "</label>";
-               echo "<select name='action$two' id='bulk-action-selector-" . esc_attr( $which ) . "'>\n";
-               echo "<option value='-1' selected='selected'>" . __( 'Bulk Actions' ) . "</option>\n";
+               echo '<label for="bulk-action-selector-' . esc_attr( $which ) . '" class="screen-reader-text">' . __( 'Select bulk action' ) . '</label>';
+               echo '<select name="action' . $two . '" id="bulk-action-selector-' . esc_attr( $which ) . "\">\n";
+               echo '<option value="-1">' . __( 'Bulk Actions' ) . "</option>\n";
 
                foreach ( $this->_actions as $name => $title ) {
-                       $class = 'edit' == $name ? ' class="hide-if-no-js"' : '';
+                       $class = 'edit' === $name ? ' class="hide-if-no-js"' : '';
 
-                       echo "\t<option value='$name'$class>$title</option>\n";
+                       echo "\t" . '<option value="' . $name . '"' . $class . '>' . $title . "</option>\n";
                }
 
                echo "</select>\n";
@@ -517,7 +540,7 @@ class WP_List_Table {
                global $wpdb, $wp_locale;
 
                /**
-                * Filter whether to remove the 'Months' drop-down from the post list table.
+                * Filters whether to remove the 'Months' drop-down from the post list table.
                 *
                 * @since 4.2.0
                 *
@@ -528,15 +551,23 @@ class WP_List_Table {
                        return;
                }
 
+               $extra_checks = "AND post_status != 'auto-draft'";
+               if ( ! isset( $_GET['post_status'] ) || 'trash' !== $_GET['post_status'] ) {
+                       $extra_checks .= " AND post_status != 'trash'";
+               } elseif ( isset( $_GET['post_status'] ) ) {
+                       $extra_checks = $wpdb->prepare( ' AND post_status = %s', $_GET['post_status'] );
+               }
+
                $months = $wpdb->get_results( $wpdb->prepare( "
                        SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month
                        FROM $wpdb->posts
                        WHERE post_type = %s
+                       $extra_checks
                        ORDER BY post_date DESC
                ", $post_type ) );
 
                /**
-                * Filter the 'Months' drop-down results.
+                * Filters the 'Months' drop-down results.
                 *
                 * @since 3.7.0
                 *
@@ -590,7 +621,7 @@ class WP_List_Table {
 <?php
                        foreach ( $this->modes as $mode => $title ) {
                                $classes = array( 'view-' . $mode );
-                               if ( $current_mode == $mode )
+                               if ( $current_mode === $mode )
                                        $classes[] = 'current';
                                printf(
                                        "<a href='%s' class='%s' id='view-switch-$mode'><span class='screen-reader-text'>%s</span></a>\n",
@@ -648,6 +679,11 @@ class WP_List_Table {
                                $pending_comments_number,
                                $pending_phrase
                        );
+               } else {
+                       printf( '<span class="post-com-count post-com-count-pending post-com-count-no-pending"><span class="comment-count comment-count-no-pending" aria-hidden="true">%s</span><span class="screen-reader-text">%s</span></span>',
+                               $pending_comments_number,
+                               $approved_comments ? __( 'No pending comments' ) : __( 'No comments' )
+                       );
                }
        }
 
@@ -684,7 +720,7 @@ class WP_List_Table {
                        $per_page = $default;
 
                /**
-                * Filter the number of items to be displayed on each page of the list table.
+                * Filters the number of items to be displayed on each page of the list table.
                 *
                 * The dynamic hook name, $option, refers to the `per_page` option depending
                 * on the type of list table in use. Possible values include: 'edit_comments_per_page',
@@ -719,18 +755,23 @@ class WP_List_Table {
                        $infinite_scroll = $this->_pagination_args['infinite_scroll'];
                }
 
+               if ( 'top' === $which && $total_pages > 1 ) {
+                       $this->screen->render_screen_reader_content( 'heading_pagination' );
+               }
+
                $output = '<span class="displaying-num">' . sprintf( _n( '%s item', '%s items', $total_items ), number_format_i18n( $total_items ) ) . '</span>';
 
                $current = $this->get_pagenum();
+               $removable_query_args = wp_removable_query_args();
 
                $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
 
-               $current_url = remove_query_arg( array( 'hotkeys_highlight_last', 'hotkeys_highlight_first' ), $current_url );
+               $current_url = remove_query_arg( $removable_query_args, $current_url );
 
                $page_links = array();
 
                $total_pages_before = '<span class="paging-input">';
-               $total_pages_after  = '</span>';
+               $total_pages_after  = '</span></span>';
 
                $disable_first = $disable_last = $disable_prev = $disable_next = false;
 
@@ -769,11 +810,11 @@ class WP_List_Table {
                        );
                }
 
-               if ( 'bottom' == $which ) {
+               if ( 'bottom' === $which ) {
                        $html_current_page  = $current;
-                       $total_pages_before = '<span class="screen-reader-text">' . __( 'Current Page' ) . '</span><span id="table-paging" class="paging-input">';
+                       $total_pages_before = '<span class="screen-reader-text">' . __( 'Current Page' ) . '</span><span id="table-paging" class="paging-input"><span class="tablenav-paging-text">';
                } else {
-                       $html_current_page = sprintf( "%s<input class='current-page' id='current-page-selector' type='text' name='paged' value='%s' size='%d' aria-describedby='table-paging' />",
+                       $html_current_page = sprintf( "%s<input class='current-page' id='current-page-selector' type='text' name='paged' value='%s' size='%d' aria-describedby='table-paging' /><span class='tablenav-paging-text'>",
                                '<label for="current-page-selector" class="screen-reader-text">' . __( 'Current Page' ) . '</label>',
                                $current,
                                strlen( $total_pages )
@@ -861,9 +902,13 @@ class WP_List_Table {
                $columns = $this->get_columns();
                $column = '';
 
+               if ( empty( $columns ) ) {
+                       return $column;
+               }
+
                // We need a primary defined so responsive views show something,
                // so let's fall back to the first non-checkbox column.
-               foreach( $columns as $col => $column_name ) {
+               foreach ( $columns as $col => $column_name ) {
                        if ( 'cb' === $col ) {
                                continue;
                        }
@@ -875,6 +920,18 @@ class WP_List_Table {
                return $column;
        }
 
+       /**
+        * Public wrapper for WP_List_Table::get_default_primary_column_name().
+        *
+        * @since 4.4.0
+        * @access public
+        *
+        * @return string Name of the default primary column.
+        */
+       public function get_primary_column() {
+               return $this->get_primary_column_name();
+       }
+
        /**
         * Gets the name of the primary column.
         *
@@ -884,7 +941,7 @@ class WP_List_Table {
         * @return string The name of the primary column.
         */
        protected function get_primary_column_name() {
-               $columns = $this->get_columns();
+               $columns = get_column_headers( $this->screen );
                $default = $this->get_default_primary_column_name();
 
                // If the primary column doesn't exist fall back to the
@@ -894,7 +951,7 @@ class WP_List_Table {
                }
 
                /**
-                * Filter the name of the primary column for the current list table.
+                * Filters the name of the primary column for the current list table.
                 *
                 * @since 4.3.0
                 *
@@ -936,7 +993,7 @@ class WP_List_Table {
 
                $sortable_columns = $this->get_sortable_columns();
                /**
-                * Filter the list table sortable columns for a specific screen.
+                * Filters the list table sortable columns for a specific screen.
                 *
                 * The dynamic portion of the hook name, `$this->screen->id`, refers
                 * to the ID of the current screen, usually a string.
@@ -995,15 +1052,17 @@ class WP_List_Table {
                $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
                $current_url = remove_query_arg( 'paged', $current_url );
 
-               if ( isset( $_GET['orderby'] ) )
+               if ( isset( $_GET['orderby'] ) ) {
                        $current_orderby = $_GET['orderby'];
-               else
+               } else {
                        $current_orderby = '';
+               }
 
-               if ( isset( $_GET['order'] ) && 'desc' == $_GET['order'] )
+               if ( isset( $_GET['order'] ) && 'desc' === $_GET['order'] ) {
                        $current_order = 'desc';
-               else
+               } else {
                        $current_order = 'asc';
+               }
 
                if ( ! empty( $columns['cb'] ) ) {
                        static $cb_counter = 1;
@@ -1019,7 +1078,7 @@ class WP_List_Table {
                                $class[] = 'hidden';
                        }
 
-                       if ( 'cb' == $column_key )
+                       if ( 'cb' === $column_key )
                                $class[] = 'check-column';
                        elseif ( in_array( $column_key, array( 'posts', 'comments', 'links' ) ) )
                                $class[] = 'num';
@@ -1031,8 +1090,8 @@ class WP_List_Table {
                        if ( isset( $sortable[$column_key] ) ) {
                                list( $orderby, $desc_first ) = $sortable[$column_key];
 
-                               if ( $current_orderby == $orderby ) {
-                                       $order = 'asc' == $current_order ? 'desc' : 'asc';
+                               if ( $current_orderby === $orderby ) {
+                                       $order = 'asc' === $current_order ? 'desc' : 'asc';
                                        $class[] = 'sorted';
                                        $class[] = $current_order;
                                } else {
@@ -1065,6 +1124,8 @@ class WP_List_Table {
                $singular = $this->_args['singular'];
 
                $this->display_tablenav( 'top' );
+
+               $this->screen->render_screen_reader_content( 'heading_list' );
 ?>
 <table class="wp-list-table <?php echo implode( ' ', $this->get_table_classes() ); ?>">
        <thead>
@@ -1092,7 +1153,7 @@ class WP_List_Table {
        }
 
        /**
-        * Get a list of CSS classes for the list table table tag.
+        * Get a list of CSS classes for the WP_List_Table table tag.
         *
         * @since 3.1.0
         * @access protected
@@ -1111,15 +1172,17 @@ class WP_List_Table {
         * @param string $which
         */
        protected function display_tablenav( $which ) {
-               if ( 'top' == $which )
+               if ( 'top' === $which ) {
                        wp_nonce_field( 'bulk-' . $this->_args['plural'] );
-?>
+               }
+               ?>
        <div class="tablenav <?php echo esc_attr( $which ); ?>">
 
+               <?php if ( $this->has_items() ): ?>
                <div class="alignleft actions bulkactions">
                        <?php $this->bulk_actions( $which ); ?>
                </div>
-<?php
+               <?php endif;
                $this->extra_tablenav( $which );
                $this->pagination( $which );
 ?>
@@ -1220,7 +1283,7 @@ class WP_List_Table {
 
                        $attributes = "class='$classes' $data";
 
-                       if ( 'cb' == $column_name ) {
+                       if ( 'cb' === $column_name ) {
                                echo '<th scope="row" class="check-column">';
                                echo $this->column_cb( $item );
                                echo '</th>';
@@ -1255,10 +1318,10 @@ class WP_List_Table {
         * @param object $item        The item being acted upon.
         * @param string $column_name Current column name.
         * @param string $primary     Primary column name.
-        * @return string The row actions output. In this case, an empty string.
+        * @return string The row actions HTML, or an empty string if the current column is the primary column.
         */
        protected function handle_row_actions( $item, $column_name, $primary ) {
-               return $column_name == $primary ? '<button type="button" class="toggle-row"><span class="screen-reader-text">' . __( 'Show more details' ) . '</span></button>' : '';
+               return $column_name === $primary ? '<button type="button" class="toggle-row"><span class="screen-reader-text">' . __( 'Show more details' ) . '</span></button>' : '';
        }
 
        /**