WordPress 4.0
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-list-table.php
index 3aa066d8afb8163eda145ee607bbdc27c8b9e36f..8d2bc51e002dc7b5558c0c6de047b05a6eb4e144 100644 (file)
@@ -2,10 +2,11 @@
 /**
  * Base class for displaying a list of items in an ajaxified HTML table.
  *
- * @package WordPress
- * @subpackage List_Table
  * @since 3.1.0
  * @access private
+ *
+ * @package WordPress
+ * @subpackage List_Table
  */
 class WP_List_Table {
 
@@ -14,9 +15,9 @@ class WP_List_Table {
         *
         * @since 3.1.0
         * @var array
-        * @access protected
+        * @access public
         */
-       var $items;
+       public $items;
 
        /**
         * Various information about the current table
@@ -25,7 +26,7 @@ class WP_List_Table {
         * @var array
         * @access private
         */
-       var $_args;
+       private $_args;
 
        /**
         * Various information needed for displaying the pagination
@@ -34,7 +35,7 @@ class WP_List_Table {
         * @var array
         * @access private
         */
-       var $_pagination_args = array();
+       private $_pagination_args = array();
 
        /**
         * The current screen
@@ -43,7 +44,7 @@ class WP_List_Table {
         * @var object
         * @access protected
         */
-       var $screen;
+       protected $screen;
 
        /**
         * Cached bulk actions
@@ -52,7 +53,7 @@ class WP_List_Table {
         * @var array
         * @access private
         */
-       var $_actions;
+       private $_actions;
 
        /**
         * Cached pagination output
@@ -61,15 +62,35 @@ class WP_List_Table {
         * @var string
         * @access private
         */
-       var $_pagination;
+       private $_pagination;
 
        /**
-        * Constructor. The child class should call this constructor from its own constructor
+        * Constructor.
         *
-        * @param array $args An associative array with information about the current table
-        * @access protected
+        * The child class should call this constructor from its own constructor to override
+        * the default $args.
+        *
+        * @since 3.1.0
+        * @access public
+        *
+        * @param array|string $args {
+        *     Array or string of arguments.
+        *
+        *     @type string $plural   Plural value used for labels and the objects being listed.
+        *                            This affects things such as CSS class-names and nonces used
+        *                            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
+        *                            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.
+        *     @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.
+        * }
         */
-       function __construct( $args = array() ) {
+       public function __construct( $args = array() ) {
                $args = wp_parse_args( $args, array(
                        'plural' => '',
                        'singular' => '',
@@ -95,6 +116,72 @@ class WP_List_Table {
                }
        }
 
+       /**
+        * Make private properties readable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to get.
+        * @return mixed Property.
+        */
+       public function __get( $name ) {
+               return $this->$name;
+       }
+
+       /**
+        * Make private properties settable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name  Property to set.
+        * @param mixed  $value Property value.
+        * @return mixed Newly-set property.
+        */
+       public function __set( $name, $value ) {
+               return $this->$name = $value;
+       }
+
+       /**
+        * Make private properties checkable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to check if set.
+        * @return bool Whether the property is set.
+        */
+       public function __isset( $name ) {
+               return isset( $this->$name );
+       }
+
+       /**
+        * Make private properties un-settable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to unset.
+        */
+       public function __unset( $name ) {
+               unset( $this->$name );
+       }
+
+       /**
+        * Make private/protected methods readable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param callable $name      Method to call.
+        * @param array    $arguments Arguments to pass when calling.
+        * @return mixed|bool Return value of the callback, false otherwise.
+        */
+       public function __call( $name, $arguments ) {
+               return call_user_func_array( array( $this, $name ), $arguments );
+       }
+
        /**
         * Checks the current user's permissions
         * @uses wp_die()
@@ -103,7 +190,7 @@ class WP_List_Table {
         * @access public
         * @abstract
         */
-       function ajax_user_can() {
+       public function ajax_user_can() {
                die( 'function WP_List_Table::ajax_user_can() must be over-ridden in a sub-class.' );
        }
 
@@ -115,7 +202,7 @@ class WP_List_Table {
         * @access public
         * @abstract
         */
-       function prepare_items() {
+       public function prepare_items() {
                die( 'function WP_List_Table::prepare_items() must be over-ridden in a sub-class.' );
        }
 
@@ -125,7 +212,7 @@ class WP_List_Table {
         * @param array $args An associative array with information about the pagination
         * @access protected
         */
-       function set_pagination_args( $args ) {
+       protected function set_pagination_args( $args ) {
                $args = wp_parse_args( $args, array(
                        'total_items' => 0,
                        'total_pages' => 0,
@@ -135,7 +222,7 @@ class WP_List_Table {
                if ( !$args['total_pages'] && $args['per_page'] > 0 )
                        $args['total_pages'] = ceil( $args['total_items'] / $args['per_page'] );
 
-               // redirect if page number is invalid and headers are not already sent
+               // 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'] ) {
                        wp_redirect( add_query_arg( 'paged', $args['total_pages'] ) );
                        exit;
@@ -153,7 +240,7 @@ class WP_List_Table {
         * @param string $key
         * @return array
         */
-       function get_pagination_arg( $key ) {
+       public function get_pagination_arg( $key ) {
                if ( 'page' == $key )
                        return $this->get_pagenum();
 
@@ -169,7 +256,7 @@ class WP_List_Table {
         *
         * @return bool
         */
-       function has_items() {
+       public function has_items() {
                return !empty( $this->items );
        }
 
@@ -179,7 +266,7 @@ class WP_List_Table {
         * @since 3.1.0
         * @access public
         */
-       function no_items() {
+       public function no_items() {
                _e( 'No items found.' );
        }
 
@@ -192,7 +279,7 @@ class WP_List_Table {
         * @param string $text The search button text
         * @param string $input_id The search input id
         */
-       function search_box( $text, $input_id ) {
+       public function search_box( $text, $input_id ) {
                if ( empty( $_REQUEST['s'] ) && !$this->has_items() )
                        return;
 
@@ -224,7 +311,7 @@ class WP_List_Table {
         *
         * @return array
         */
-       function get_views() {
+       protected function get_views() {
                return array();
        }
 
@@ -234,7 +321,7 @@ class WP_List_Table {
         * @since 3.1.0
         * @access public
         */
-       function views() {
+       public function views() {
                $views = $this->get_views();
                /**
                 * Filter the list of available list table views.
@@ -268,7 +355,7 @@ class WP_List_Table {
         *
         * @return array
         */
-       function get_bulk_actions() {
+       protected function get_bulk_actions() {
                return array();
        }
 
@@ -276,9 +363,12 @@ class WP_List_Table {
         * Display the bulk actions dropdown.
         *
         * @since 3.1.0
-        * @access public
+        * @access protected
+        *
+        * @param string $which The location of the bulk actions: 'top' or 'bottom'.
+        *                      This is designated as optional for backwards-compatibility.
         */
-       function bulk_actions() {
+       protected function bulk_actions( $which = '' ) {
                if ( is_null( $this->_actions ) ) {
                        $no_new_actions = $this->_actions = $this->get_bulk_actions();
                        /**
@@ -303,7 +393,8 @@ class WP_List_Table {
                if ( empty( $this->_actions ) )
                        return;
 
-               echo "<select name='action$two'>\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' selected='selected'>" . __( 'Bulk Actions' ) . "</option>\n";
 
                foreach ( $this->_actions as $name => $title ) {
@@ -326,7 +417,10 @@ class WP_List_Table {
         *
         * @return string|bool The action name or False if no action was selected
         */
-       function current_action() {
+       public function current_action() {
+               if ( isset( $_REQUEST['filter_action'] ) && ! empty( $_REQUEST['filter_action'] ) )
+                       return false;
+
                if ( isset( $_REQUEST['action'] ) && -1 != $_REQUEST['action'] )
                        return $_REQUEST['action'];
 
@@ -346,7 +440,7 @@ class WP_List_Table {
         * @param bool $always_visible Whether the actions should be always visible
         * @return string
         */
-       function row_actions( $actions, $always_visible = false ) {
+       protected function row_actions( $actions, $always_visible = false ) {
                $action_count = count( $actions );
                $i = 0;
 
@@ -370,7 +464,7 @@ class WP_List_Table {
         * @since 3.1.0
         * @access protected
         */
-       function months_dropdown( $post_type ) {
+       protected function months_dropdown( $post_type ) {
                global $wpdb, $wp_locale;
 
                $months = $wpdb->get_results( $wpdb->prepare( "
@@ -397,8 +491,9 @@ class WP_List_Table {
 
                $m = isset( $_GET['m'] ) ? (int) $_GET['m'] : 0;
 ?>
-               <select name='m'>
-                       <option<?php selected( $m, 0 ); ?> value='0'><?php _e( 'All dates' ); ?></option>
+               <label for="filter-by-date" class="screen-reader-text"><?php _e( 'Filter by date' ); ?></label>
+               <select name="m" id="filter-by-date">
+                       <option<?php selected( $m, 0 ); ?> value="0"><?php _e( 'All dates' ); ?></option>
 <?php
                foreach ( $months as $arc_row ) {
                        if ( 0 == $arc_row->year )
@@ -425,7 +520,7 @@ class WP_List_Table {
         * @since 3.1.0
         * @access protected
         */
-       function view_switcher( $current_mode ) {
+       protected function view_switcher( $current_mode ) {
                $modes = array(
                        'list'    => __( 'List View' ),
                        'excerpt' => __( 'Excerpt View' )
@@ -436,8 +531,15 @@ class WP_List_Table {
                <div class="view-switch">
 <?php
                        foreach ( $modes as $mode => $title ) {
-                               $class = ( $current_mode == $mode ) ? 'class="current"' : '';
-                               echo "<a href='" . esc_url( add_query_arg( 'mode', $mode, $_SERVER['REQUEST_URI'] ) ) . "' $class><img id='view-switch-$mode' src='" . esc_url( includes_url( 'images/blank.gif' ) ) . "' width='20' height='20' title='$title' alt='$title' /></a>\n";
+                               $classes = array( 'view-' . $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",
+                                       esc_url( add_query_arg( 'mode', $mode ) ),
+                                       implode( ' ', $classes ),
+                                       $title
+                               );
                        }
                ?>
                </div>
@@ -450,10 +552,10 @@ class WP_List_Table {
         * @since 3.1.0
         * @access protected
         *
-        * @param int $post_id
-        * @param int $pending_comments
+        * @param int $post_id          The post ID.
+        * @param int $pending_comments Number of pending comments.
         */
-       function comments_bubble( $post_id, $pending_comments ) {
+       protected function comments_bubble( $post_id, $pending_comments ) {
                $pending_phrase = sprintf( __( '%s pending' ), number_format( $pending_comments ) );
 
                if ( $pending_comments )
@@ -469,11 +571,11 @@ class WP_List_Table {
         * Get the current page number
         *
         * @since 3.1.0
-        * @access protected
+        * @access public
         *
         * @return int
         */
-       function get_pagenum() {
+       public function get_pagenum() {
                $pagenum = isset( $_REQUEST['paged'] ) ? absint( $_REQUEST['paged'] ) : 0;
 
                if( isset( $this->_pagination_args['total_pages'] ) && $pagenum > $this->_pagination_args['total_pages'] )
@@ -490,7 +592,7 @@ class WP_List_Table {
         *
         * @return int
         */
-       function get_items_per_page( $option, $default = 20 ) {
+       protected function get_items_per_page( $option, $default = 20 ) {
                $per_page = (int) get_user_option( $option );
                if ( empty( $per_page ) || $per_page < 1 )
                        $per_page = $default;
@@ -516,11 +618,17 @@ class WP_List_Table {
         * @since 3.1.0
         * @access protected
         */
-       function pagination( $which ) {
-               if ( empty( $this->_pagination_args ) )
+       protected function pagination( $which ) {
+               if ( empty( $this->_pagination_args ) ) {
                        return;
+               }
 
-               extract( $this->_pagination_args, EXTR_SKIP );
+               $total_items = $this->_pagination_args['total_items'];
+               $total_pages = $this->_pagination_args['total_pages'];
+               $infinite_scroll = false;
+               if ( isset( $this->_pagination_args['infinite_scroll'] ) ) {
+                       $infinite_scroll = $this->_pagination_args['infinite_scroll'];
+               }
 
                $output = '<span class="displaying-num">' . sprintf( _n( '1 item', '%s items', $total_items ), number_format_i18n( $total_items ) ) . '</span>';
 
@@ -533,11 +641,12 @@ class WP_List_Table {
                $page_links = array();
 
                $disable_first = $disable_last = '';
-               if ( $current == 1 )
+               if ( $current == 1 ) {
                        $disable_first = ' disabled';
-               if ( $current == $total_pages )
+               }
+               if ( $current == $total_pages ) {
                        $disable_last = ' disabled';
-
+               }
                $page_links[] = sprintf( "<a class='%s' title='%s' href='%s'>%s</a>",
                        'first-page' . $disable_first,
                        esc_attr__( 'Go to the first page' ),
@@ -552,15 +661,16 @@ class WP_List_Table {
                        '&lsaquo;'
                );
 
-               if ( 'bottom' == $which )
+               if ( 'bottom' == $which ) {
                        $html_current_page = $current;
-               else
-                       $html_current_page = sprintf( "<input class='current-page' title='%s' type='text' name='paged' value='%s' size='%d' />",
+               } else {
+                       $html_current_page = sprintf( "%s<input class='current-page' id='current-page-selector' title='%s' type='text' name='paged' value='%s' size='%d' />",
+                               '<label for="current-page-selector" class="screen-reader-text">' . __( 'Select Page' ) . '</label>',
                                esc_attr__( 'Current page' ),
                                $current,
                                strlen( $total_pages )
                        );
-
+               }
                $html_total_pages = sprintf( "<span class='total-pages'>%s</span>", number_format_i18n( $total_pages ) );
                $page_links[] = '<span class="paging-input">' . sprintf( _x( '%1$s of %2$s', 'paging' ), $html_current_page, $html_total_pages ) . '</span>';
 
@@ -579,15 +689,16 @@ class WP_List_Table {
                );
 
                $pagination_links_class = 'pagination-links';
-               if ( ! empty( $infinite_scroll ) )
+               if ( ! empty( $infinite_scroll ) ) {
                        $pagination_links_class = ' hide-if-js';
+               }
                $output .= "\n<span class='$pagination_links_class'>" . join( "\n", $page_links ) . '</span>';
 
-               if ( $total_pages )
+               if ( $total_pages ) {
                        $page_class = $total_pages < 2 ? ' one-page' : '';
-               else
+               } else {
                        $page_class = ' no-pages';
-
+               }
                $this->_pagination = "<div class='tablenav-pages{$page_class}'>$output</div>";
 
                echo $this->_pagination;
@@ -598,12 +709,12 @@ class WP_List_Table {
         * 'internal-name' => 'Title'
         *
         * @since 3.1.0
-        * @access protected
+        * @access public
         * @abstract
         *
         * @return array
         */
-       function get_columns() {
+       public function get_columns() {
                die( 'function WP_List_Table::get_columns() must be over-ridden in a sub-class.' );
        }
 
@@ -620,7 +731,7 @@ class WP_List_Table {
         *
         * @return array
         */
-       function get_sortable_columns() {
+       protected function get_sortable_columns() {
                return array();
        }
 
@@ -632,7 +743,7 @@ class WP_List_Table {
         *
         * @return array
         */
-       function get_column_info() {
+       protected function get_column_info() {
                if ( isset( $this->_column_headers ) )
                        return $this->_column_headers;
 
@@ -677,7 +788,7 @@ class WP_List_Table {
         *
         * @return int
         */
-       function get_column_count() {
+       public function get_column_count() {
                list ( $columns, $hidden ) = $this->get_column_info();
                $hidden = array_intersect( array_keys( $columns ), array_filter( $hidden ) );
                return count( $columns ) - count( $hidden );
@@ -687,11 +798,11 @@ class WP_List_Table {
         * Print column headers, accounting for hidden and sortable columns.
         *
         * @since 3.1.0
-        * @access protected
+        * @access public
         *
         * @param bool $with_id Whether to set the id attribute or not
         */
-       function print_column_headers( $with_id = true ) {
+       public function print_column_headers( $with_id = true ) {
                list( $columns, $hidden, $sortable ) = $this->get_column_info();
 
                $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
@@ -759,8 +870,8 @@ class WP_List_Table {
         * @since 3.1.0
         * @access public
         */
-       function display() {
-               extract( $this->_args );
+       public function display() {
+               $singular = $this->_args['singular'];
 
                $this->display_tablenav( 'top' );
 
@@ -778,7 +889,10 @@ class WP_List_Table {
        </tr>
        </tfoot>
 
-       <tbody id="the-list"<?php if ( $singular ) echo " data-wp-lists='list:$singular'"; ?>>
+       <tbody id="the-list"<?php
+               if ( $singular ) {
+                       echo " data-wp-lists='list:$singular'";
+               } ?>>
                <?php $this->display_rows_or_placeholder(); ?>
        </tbody>
 </table>
@@ -794,7 +908,7 @@ class WP_List_Table {
         *
         * @return array
         */
-       function get_table_classes() {
+       protected function get_table_classes() {
                return array( 'widefat', 'fixed', $this->_args['plural'] );
        }
 
@@ -804,14 +918,14 @@ class WP_List_Table {
         * @since 3.1.0
         * @access protected
         */
-       function display_tablenav( $which ) {
+       protected function display_tablenav( $which ) {
                if ( 'top' == $which )
                        wp_nonce_field( 'bulk-' . $this->_args['plural'] );
 ?>
        <div class="tablenav <?php echo esc_attr( $which ); ?>">
 
                <div class="alignleft actions bulkactions">
-                       <?php $this->bulk_actions(); ?>
+                       <?php $this->bulk_actions( $which ); ?>
                </div>
 <?php
                $this->extra_tablenav( $which );
@@ -829,19 +943,18 @@ class WP_List_Table {
         * @since 3.1.0
         * @access protected
         */
-       function extra_tablenav( $which ) {}
+       protected function extra_tablenav( $which ) {}
 
        /**
         * Generate the <tbody> part of the table
         *
         * @since 3.1.0
-        * @access protected
+        * @access public
         */
-       function display_rows_or_placeholder() {
+       public function display_rows_or_placeholder() {
                if ( $this->has_items() ) {
                        $this->display_rows();
                } else {
-                       list( $columns, $hidden ) = $this->get_column_info();
                        echo '<tr class="no-items"><td class="colspanchange" colspan="' . $this->get_column_count() . '">';
                        $this->no_items();
                        echo '</td></tr>';
@@ -852,9 +965,9 @@ class WP_List_Table {
         * Generate the table rows
         *
         * @since 3.1.0
-        * @access protected
+        * @access public
         */
-       function display_rows() {
+       public function display_rows() {
                foreach ( $this->items as $item )
                        $this->single_row( $item );
        }
@@ -863,11 +976,11 @@ class WP_List_Table {
         * Generates content for a single row of the table
         *
         * @since 3.1.0
-        * @access protected
+        * @access public
         *
         * @param object $item The current item
         */
-       function single_row( $item ) {
+       public function single_row( $item ) {
                static $row_class = '';
                $row_class = ( $row_class == '' ? ' class="alternate"' : '' );
 
@@ -884,7 +997,7 @@ class WP_List_Table {
         *
         * @param object $item The current item
         */
-       function single_row_columns( $item ) {
+       protected function single_row_columns( $item ) {
                list( $columns, $hidden ) = $this->get_column_info();
 
                foreach ( $columns as $column_name => $column_display_name ) {
@@ -920,28 +1033,29 @@ class WP_List_Table {
         * @since 3.1.0
         * @access public
         */
-       function ajax_response() {
+       public function ajax_response() {
                $this->prepare_items();
 
-               extract( $this->_args );
-               extract( $this->_pagination_args, EXTR_SKIP );
-
                ob_start();
-               if ( ! empty( $_REQUEST['no_placeholder'] ) )
+               if ( ! empty( $_REQUEST['no_placeholder'] ) ) {
                        $this->display_rows();
-               else
+               } else {
                        $this->display_rows_or_placeholder();
+               }
 
                $rows = ob_get_clean();
 
                $response = array( 'rows' => $rows );
 
-               if ( isset( $total_items ) )
-                       $response['total_items_i18n'] = sprintf( _n( '1 item', '%s items', $total_items ), number_format_i18n( $total_items ) );
-
-               if ( isset( $total_pages ) ) {
-                       $response['total_pages'] = $total_pages;
-                       $response['total_pages_i18n'] = number_format_i18n( $total_pages );
+               if ( isset( $this->_pagination_args['total_items'] ) ) {
+                       $response['total_items_i18n'] = sprintf(
+                               _n( '1 item', '%s items', $this->_pagination_args['total_items'] ),
+                               number_format_i18n( $this->_pagination_args['total_items'] )
+                       );
+               }
+               if ( isset( $this->_pagination_args['total_pages'] ) ) {
+                       $response['total_pages'] = $this->_pagination_args['total_pages'];
+                       $response['total_pages_i18n'] = number_format_i18n( $this->_pagination_args['total_pages'] );
                }
 
                die( json_encode( $response ) );
@@ -950,9 +1064,9 @@ class WP_List_Table {
        /**
         * Send required variables to JavaScript land
         *
-        * @access private
+        * @access public
         */
-       function _js_vars() {
+       public function _js_vars() {
                $args = array(
                        'class'  => get_class( $this ),
                        'screen' => array(