--- a/wp/wp-admin/includes/class-wp-list-table.php Tue Jun 09 11:14:17 2015 +0000
+++ b/wp/wp-admin/includes/class-wp-list-table.php Mon Oct 14 17:39:30 2019 +0200
@@ -1,35 +1,38 @@
<?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
*/
public $items;
/**
- * Various information about the current table
+ * Various information about the current table.
*
* @since 3.1.0
* @var array
- * @access protected
*/
protected $_args;
/**
- * Various information needed for displaying the pagination
+ * Various information needed for displaying the pagination.
*
* @since 3.1.0
* @var array
@@ -37,29 +40,26 @@
protected $_pagination_args = array();
/**
- * The current screen
+ * The current screen.
*
* @since 3.1.0
* @var object
- * @access protected
*/
protected $screen;
/**
- * Cached bulk actions
+ * Cached bulk actions.
*
* @since 3.1.0
* @var array
- * @access private
*/
private $_actions;
/**
- * Cached pagination output
+ * Cached pagination output.
*
* @since 3.1.0
* @var string
- * @access private
*/
private $_pagination;
@@ -68,19 +68,29 @@
*
* @since 4.1.0
* @var array
- * @access protected
*/
protected $modes = array();
/**
- * Stores the value returned by ->get_column_info()
+ * Stores the value returned by ->get_column_info().
*
+ * @since 4.1.0
* @var array
*/
protected $_column_headers;
+ /**
+ * {@internal Missing Summary}
+ *
+ * @var array
+ */
protected $compat_fields = array( '_args', '_pagination_args', 'screen', '_actions', '_pagination' );
+ /**
+ * {@internal Missing Summary}
+ *
+ * @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',
@@ -93,7 +103,6 @@
* the default $args.
*
* @since 3.1.0
- * @access public
*
* @param array|string $args {
* Array or string of arguments.
@@ -103,10 +112,10 @@
* 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,10 +155,9 @@
}
/**
- * Make private properties readable for backwards compatibility.
+ * Make private properties readable for backward compatibility.
*
* @since 4.0.0
- * @access public
*
* @param string $name Property to get.
* @return mixed Property.
@@ -161,10 +169,9 @@
}
/**
- * Make private properties settable for backwards compatibility.
+ * Make private properties settable for backward compatibility.
*
* @since 4.0.0
- * @access public
*
* @param string $name Property to check if set.
* @param mixed $value Property value.
@@ -177,10 +184,9 @@
}
/**
- * Make private properties checkable for backwards compatibility.
+ * Make private properties checkable for backward compatibility.
*
* @since 4.0.0
- * @access public
*
* @param string $name Property to check if set.
* @return bool Whether the property is set.
@@ -192,10 +198,9 @@
}
/**
- * Make private properties un-settable for backwards compatibility.
+ * Make private properties un-settable for backward compatibility.
*
* @since 4.0.0
- * @access public
*
* @param string $name Property to unset.
*/
@@ -206,10 +211,9 @@
}
/**
- * Make private/protected methods readable for backwards compatibility.
+ * Make private/protected methods readable for backward compatibility.
*
* @since 4.0.0
- * @access public
*
* @param callable $name Method to call.
* @param array $arguments Arguments to pass when calling.
@@ -226,7 +230,6 @@
* Checks the current user's permissions
*
* @since 3.1.0
- * @access public
* @abstract
*/
public function ajax_user_can() {
@@ -238,7 +241,6 @@
* @uses WP_List_Table::set_pagination_args()
*
* @since 3.1.0
- * @access public
* @abstract
*/
public function prepare_items() {
@@ -248,8 +250,9 @@
/**
* An internal method that sets all the necessary pagination arguments
*
- * @param array $args An associative array with information about the pagination
- * @access protected
+ * @since 3.1.0
+ *
+ * @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(
@@ -262,7 +265,7 @@
$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;
}
@@ -274,25 +277,25 @@
* Access the pagination args.
*
* @since 3.1.0
- * @access public
*
* @param string $key Pagination argument to retrieve. Common values include 'total_items',
* 'total_pages', 'per_page', or 'infinite_scroll'.
* @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];
+ }
}
/**
* Whether the table has items to display or not
*
* @since 3.1.0
- * @access public
*
* @return bool
*/
@@ -304,20 +307,18 @@
* Message to be displayed when there are no items
*
* @since 3.1.0
- * @access public
*/
public function no_items() {
_e( 'No items found.' );
}
/**
- * 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() )
@@ -335,9 +336,9 @@
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
}
@@ -347,7 +348,6 @@
* of views available on this table.
*
* @since 3.1.0
- * @access protected
*
* @return array
*/
@@ -359,12 +359,11 @@
* Display the list of views available on this table.
*
* @since 3.1.0
- * @access public
*/
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.
@@ -378,6 +377,8 @@
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";
@@ -391,7 +392,6 @@
* of bulk actions available on this table.
*
* @since 3.1.0
- * @access protected
*
* @return array
*/
@@ -403,16 +403,15 @@
* Display the bulk actions dropdown.
*
* @since 3.1.0
- * @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.
@@ -424,7 +423,6 @@
* @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';
@@ -433,14 +431,14 @@
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";
@@ -453,9 +451,8 @@
* Get the current action selected from the bulk actions dropdown.
*
* @since 3.1.0
- * @access public
*
- * @return string|bool The action name or False if no action was selected
+ * @return string|false The action name or False if no action was selected
*/
public function current_action() {
if ( isset( $_REQUEST['filter_action'] ) && ! empty( $_REQUEST['filter_action'] ) )
@@ -474,7 +471,6 @@
* Generate row actions div
*
* @since 3.1.0
- * @access protected
*
* @param array $actions The list of actions
* @param bool $always_visible Whether the actions should be always visible
@@ -495,6 +491,8 @@
}
$out .= '</div>';
+ $out .= '<button type="button" class="toggle-row"><span class="screen-reader-text">' . __( 'Show more details' ) . '</span></button>';
+
return $out;
}
@@ -502,7 +500,9 @@
* Display a monthly dropdown for filtering items
*
* @since 3.1.0
- * @access protected
+ *
+ * @global wpdb $wpdb
+ * @global WP_Locale $wp_locale
*
* @param string $post_type
*/
@@ -510,7 +510,7 @@
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
*
@@ -521,15 +521,23 @@
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
*
@@ -572,7 +580,6 @@
* Display a view switcher
*
* @since 3.1.0
- * @access protected
*
* @param string $current_mode
*/
@@ -583,7 +590,7 @@
<?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",
@@ -601,35 +608,64 @@
* Display a comment count bubble
*
* @since 3.1.0
- * @access protected
*
* @param int $post_id The post ID.
* @param int $pending_comments Number of pending comments.
*/
protected function comments_bubble( $post_id, $pending_comments ) {
- $pending_phrase = sprintf( __( '%s pending' ), number_format( $pending_comments ) );
+ $approved_comments = get_comments_number();
- if ( $pending_comments )
- echo '<strong>';
+ $approved_comments_number = number_format_i18n( $approved_comments );
+ $pending_comments_number = number_format_i18n( $pending_comments );
+
+ $approved_only_phrase = sprintf( _n( '%s comment', '%s comments', $approved_comments ), $approved_comments_number );
+ $approved_phrase = sprintf( _n( '%s approved comment', '%s approved comments', $approved_comments ), $approved_comments_number );
+ $pending_phrase = sprintf( _n( '%s pending comment', '%s pending comments', $pending_comments ), $pending_comments_number );
- echo "<a href='" . esc_url( add_query_arg( 'p', $post_id, admin_url( 'edit-comments.php' ) ) ) . "' title='" . esc_attr( $pending_phrase ) . "' class='post-com-count'><span class='comment-count'>" . number_format_i18n( get_comments_number() ) . "</span></a>";
+ // No comments at all.
+ if ( ! $approved_comments && ! $pending_comments ) {
+ printf( '<span aria-hidden="true">—</span><span class="screen-reader-text">%s</span>',
+ __( 'No comments' )
+ );
+ // Approved comments have different display depending on some conditions.
+ } elseif ( $approved_comments ) {
+ printf( '<a href="%s" class="post-com-count post-com-count-approved"><span class="comment-count-approved" aria-hidden="true">%s</span><span class="screen-reader-text">%s</span></a>',
+ esc_url( add_query_arg( array( 'p' => $post_id, 'comment_status' => 'approved' ), admin_url( 'edit-comments.php' ) ) ),
+ $approved_comments_number,
+ $pending_comments ? $approved_phrase : $approved_only_phrase
+ );
+ } else {
+ printf( '<span class="post-com-count post-com-count-no-comments"><span class="comment-count comment-count-no-comments" aria-hidden="true">%s</span><span class="screen-reader-text">%s</span></span>',
+ $approved_comments_number,
+ $pending_comments ? __( 'No approved comments' ) : __( 'No comments' )
+ );
+ }
- if ( $pending_comments )
- echo '</strong>';
+ if ( $pending_comments ) {
+ printf( '<a href="%s" class="post-com-count post-com-count-pending"><span class="comment-count-pending" aria-hidden="true">%s</span><span class="screen-reader-text">%s</span></a>',
+ esc_url( add_query_arg( array( 'p' => $post_id, 'comment_status' => 'moderated' ), admin_url( 'edit-comments.php' ) ) ),
+ $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' )
+ );
+ }
}
/**
* Get the current page number
*
* @since 3.1.0
- * @access public
*
* @return int
*/
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'] )
+ if ( isset( $this->_pagination_args['total_pages'] ) && $pagenum > $this->_pagination_args['total_pages'] )
$pagenum = $this->_pagination_args['total_pages'];
return max( 1, $pagenum );
@@ -639,7 +675,6 @@
* Get number of items to display on a single page
*
* @since 3.1.0
- * @access protected
*
* @param string $option
* @param int $default
@@ -651,7 +686,7 @@
$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',
@@ -663,14 +698,13 @@
*
* @param int $per_page Number of items to be displayed. Default 20.
*/
- return (int) apply_filters( $option, $per_page );
+ return (int) apply_filters( "{$option}", $per_page );
}
/**
* Display the pagination.
*
* @since 3.1.0
- * @access protected
*
* @param string $which
*/
@@ -686,67 +720,97 @@
$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>';
+ 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();
- $disable_first = $disable_last = '';
- if ( $current == 1 ) {
- $disable_first = ' disabled';
- }
- if ( $current == $total_pages ) {
- $disable_last = ' disabled';
+ $total_pages_before = '<span class="paging-input">';
+ $total_pages_after = '</span></span>';
+
+ $disable_first = $disable_last = $disable_prev = $disable_next = false;
+
+ if ( $current == 1 ) {
+ $disable_first = true;
+ $disable_prev = true;
+ }
+ if ( $current == 2 ) {
+ $disable_first = true;
}
- $page_links[] = sprintf( "<a class='%s' title='%s' href='%s'>%s</a>",
- 'first-page' . $disable_first,
- esc_attr__( 'Go to the first page' ),
- esc_url( remove_query_arg( 'paged', $current_url ) ),
- '«'
- );
+ if ( $current == $total_pages ) {
+ $disable_last = true;
+ $disable_next = true;
+ }
+ if ( $current == $total_pages - 1 ) {
+ $disable_last = true;
+ }
- $page_links[] = sprintf( "<a class='%s' title='%s' href='%s'>%s</a>",
- 'prev-page' . $disable_first,
- esc_attr__( 'Go to the previous page' ),
- esc_url( add_query_arg( 'paged', max( 1, $current-1 ), $current_url ) ),
- '‹'
- );
+ if ( $disable_first ) {
+ $page_links[] = '<span class="tablenav-pages-navspan" aria-hidden="true">«</span>';
+ } else {
+ $page_links[] = sprintf( "<a class='first-page' href='%s'><span class='screen-reader-text'>%s</span><span aria-hidden='true'>%s</span></a>",
+ esc_url( remove_query_arg( 'paged', $current_url ) ),
+ __( 'First page' ),
+ '«'
+ );
+ }
- if ( 'bottom' == $which ) {
- $html_current_page = $current;
+ if ( $disable_prev ) {
+ $page_links[] = '<span class="tablenav-pages-navspan" aria-hidden="true">‹</span>';
} 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' ),
+ $page_links[] = sprintf( "<a class='prev-page' href='%s'><span class='screen-reader-text'>%s</span><span aria-hidden='true'>%s</span></a>",
+ esc_url( add_query_arg( 'paged', max( 1, $current-1 ), $current_url ) ),
+ __( 'Previous page' ),
+ '‹'
+ );
+ }
+
+ 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"><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' /><span class='tablenav-paging-text'>",
+ '<label for="current-page-selector" class="screen-reader-text">' . __( 'Current Page' ) . '</label>',
$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>';
+ $page_links[] = $total_pages_before . sprintf( _x( '%1$s of %2$s', 'paging' ), $html_current_page, $html_total_pages ) . $total_pages_after;
- $page_links[] = sprintf( "<a class='%s' title='%s' href='%s'>%s</a>",
- 'next-page' . $disable_last,
- esc_attr__( 'Go to the next page' ),
- esc_url( add_query_arg( 'paged', min( $total_pages, $current+1 ), $current_url ) ),
- '›'
- );
+ if ( $disable_next ) {
+ $page_links[] = '<span class="tablenav-pages-navspan" aria-hidden="true">›</span>';
+ } else {
+ $page_links[] = sprintf( "<a class='next-page' href='%s'><span class='screen-reader-text'>%s</span><span aria-hidden='true'>%s</span></a>",
+ esc_url( add_query_arg( 'paged', min( $total_pages, $current+1 ), $current_url ) ),
+ __( 'Next page' ),
+ '›'
+ );
+ }
- $page_links[] = sprintf( "<a class='%s' title='%s' href='%s'>%s</a>",
- 'last-page' . $disable_last,
- esc_attr__( 'Go to the last page' ),
- esc_url( add_query_arg( 'paged', $total_pages, $current_url ) ),
- '»'
- );
+ if ( $disable_last ) {
+ $page_links[] = '<span class="tablenav-pages-navspan" aria-hidden="true">»</span>';
+ } else {
+ $page_links[] = sprintf( "<a class='last-page' href='%s'><span class='screen-reader-text'>%s</span><span aria-hidden='true'>%s</span></a>",
+ esc_url( add_query_arg( 'paged', $total_pages, $current_url ) ),
+ __( 'Last page' ),
+ '»'
+ );
+ }
$pagination_links_class = 'pagination-links';
if ( ! empty( $infinite_scroll ) ) {
- $pagination_links_class = ' hide-if-js';
+ $pagination_links_class .= ' hide-if-js';
}
$output .= "\n<span class='$pagination_links_class'>" . join( "\n", $page_links ) . '</span>';
@@ -765,7 +829,6 @@
* 'internal-name' => 'Title'
*
* @since 3.1.0
- * @access public
* @abstract
*
* @return array
@@ -783,7 +846,6 @@
* The second format will make the initial sorting order be descending
*
* @since 3.1.0
- * @access protected
*
* @return array
*/
@@ -792,23 +854,105 @@
}
/**
+ * Gets the name of the default primary column.
+ *
+ * @since 4.3.0
+ *
+ * @return string Name of the default primary column, in this case, an empty string.
+ */
+ protected function get_default_primary_column_name() {
+ $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 ) {
+ if ( 'cb' === $col ) {
+ continue;
+ }
+
+ $column = $col;
+ break;
+ }
+
+ return $column;
+ }
+
+ /**
+ * Public wrapper for WP_List_Table::get_default_primary_column_name().
+ *
+ * @since 4.4.0
+ *
+ * @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.
+ *
+ * @since 4.3.0
+ *
+ * @return string The name of the primary column.
+ */
+ protected function get_primary_column_name() {
+ $columns = get_column_headers( $this->screen );
+ $default = $this->get_default_primary_column_name();
+
+ // If the primary column doesn't exist fall back to the
+ // first non-checkbox column.
+ if ( ! isset( $columns[ $default ] ) ) {
+ $default = WP_List_Table::get_default_primary_column_name();
+ }
+
+ /**
+ * Filters the name of the primary column for the current list table.
+ *
+ * @since 4.3.0
+ *
+ * @param string $default Column name default for the specific list table, e.g. 'name'.
+ * @param string $context Screen ID for specific list table, e.g. 'plugins'.
+ */
+ $column = apply_filters( 'list_table_primary_column', $default, $this->screen->id );
+
+ if ( empty( $column ) || ! isset( $columns[ $column ] ) ) {
+ $column = $default;
+ }
+
+ return $column;
+ }
+
+ /**
* Get a list of all, hidden and sortable columns, with filter applied
*
* @since 3.1.0
- * @access protected
*
* @return array
*/
protected function get_column_info() {
- if ( isset( $this->_column_headers ) )
- return $this->_column_headers;
+ // $_column_headers is already set / cached
+ if ( isset( $this->_column_headers ) && is_array( $this->_column_headers ) ) {
+ // Back-compat for list tables that have been manually setting $_column_headers for horse reasons.
+ // In 4.3, we added a fourth argument for primary column.
+ $column_headers = array( array(), array(), array(), $this->get_primary_column_name() );
+ foreach ( $this->_column_headers as $key => $value ) {
+ $column_headers[ $key ] = $value;
+ }
+
+ return $column_headers;
+ }
$columns = get_column_headers( $this->screen );
$hidden = get_hidden_columns( $this->screen );
$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.
@@ -831,7 +975,8 @@
$sortable[$id] = $data;
}
- $this->_column_headers = array( $columns, $hidden, $sortable );
+ $primary = $this->get_primary_column_name();
+ $this->_column_headers = array( $columns, $hidden, $sortable, $primary );
return $this->_column_headers;
}
@@ -840,7 +985,6 @@
* Return number of visible columns
*
* @since 3.1.0
- * @access public
*
* @return int
*/
@@ -854,25 +998,28 @@
* Print column headers, accounting for hidden and sortable columns.
*
* @since 3.1.0
- * @access public
+ *
+ * @staticvar int $cb_counter
*
* @param bool $with_id Whether to set the id attribute or not
*/
public function print_column_headers( $with_id = true ) {
- list( $columns, $hidden, $sortable ) = $this->get_column_info();
+ list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
$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;
@@ -884,22 +1031,24 @@
foreach ( $columns as $column_key => $column_display_name ) {
$class = array( 'manage-column', "column-$column_key" );
- $style = '';
- if ( in_array( $column_key, $hidden ) )
- $style = 'display:none;';
+ if ( in_array( $column_key, $hidden ) ) {
+ $class[] = 'hidden';
+ }
- $style = ' style="' . $style . '"';
-
- if ( 'cb' == $column_key )
+ if ( 'cb' === $column_key )
$class[] = 'check-column';
elseif ( in_array( $column_key, array( 'posts', 'comments', 'links' ) ) )
$class[] = 'num';
+ if ( $column_key === $primary ) {
+ $class[] = 'column-primary';
+ }
+
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 {
@@ -911,12 +1060,14 @@
$column_display_name = '<a href="' . esc_url( add_query_arg( compact( 'orderby', 'order' ), $current_url ) ) . '"><span>' . $column_display_name . '</span><span class="sorting-indicator"></span></a>';
}
+ $tag = ( 'cb' === $column_key ) ? 'td' : 'th';
+ $scope = ( 'th' === $tag ) ? 'scope="col"' : '';
$id = $with_id ? "id='$column_key'" : '';
if ( !empty( $class ) )
$class = "class='" . join( ' ', $class ) . "'";
- echo "<th scope='col' $id $class $style>$column_display_name</th>";
+ echo "<$tag $scope $id $class>$column_display_name</$tag>";
}
}
@@ -924,13 +1075,13 @@
* Display the table
*
* @since 3.1.0
- * @access public
*/
public function display() {
$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>
@@ -958,10 +1109,9 @@
}
/**
- * 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
*
* @return array List of CSS classes for the table tag.
*/
@@ -973,19 +1123,20 @@
* Generate the table navigation above or below the table
*
* @since 3.1.0
- * @access protected
* @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 );
?>
@@ -999,7 +1150,6 @@
* Extra controls to be displayed between bulk actions and pagination
*
* @since 3.1.0
- * @access protected
*
* @param string $which
*/
@@ -1009,7 +1159,6 @@
* Generate the tbody element for the list table.
*
* @since 3.1.0
- * @access public
*/
public function display_rows_or_placeholder() {
if ( $this->has_items() ) {
@@ -1025,7 +1174,6 @@
* Generate the table rows
*
* @since 3.1.0
- * @access public
*/
public function display_rows() {
foreach ( $this->items as $item )
@@ -1036,7 +1184,6 @@
* Generates content for a single row of the table
*
* @since 3.1.0
- * @access public
*
* @param object $item The current item
*/
@@ -1046,53 +1193,89 @@
echo '</tr>';
}
+ /**
+ *
+ * @param object $item
+ * @param string $column_name
+ */
protected function column_default( $item, $column_name ) {}
+ /**
+ *
+ * @param object $item
+ */
protected function column_cb( $item ) {}
/**
* Generates the columns for a single row of the table
*
* @since 3.1.0
- * @access protected
*
* @param object $item The current item
*/
protected function single_row_columns( $item ) {
- list( $columns, $hidden ) = $this->get_column_info();
+ list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
foreach ( $columns as $column_name => $column_display_name ) {
- $class = "class='$column_name column-$column_name'";
+ $classes = "$column_name column-$column_name";
+ if ( $primary === $column_name ) {
+ $classes .= ' has-row-actions column-primary';
+ }
- $style = '';
- if ( in_array( $column_name, $hidden ) )
- $style = ' style="display:none;"';
+ if ( in_array( $column_name, $hidden ) ) {
+ $classes .= ' hidden';
+ }
- $attributes = "$class$style";
+ // Comments column uses HTML in the display name with screen reader text.
+ // Instead of using esc_attr(), we strip tags to get closer to a user-friendly string.
+ $data = 'data-colname="' . wp_strip_all_tags( $column_display_name ) . '"';
- if ( 'cb' == $column_name ) {
+ $attributes = "class='$classes' $data";
+
+ if ( 'cb' === $column_name ) {
echo '<th scope="row" class="check-column">';
echo $this->column_cb( $item );
echo '</th>';
- }
- elseif ( method_exists( $this, 'column_' . $column_name ) ) {
+ } elseif ( method_exists( $this, '_column_' . $column_name ) ) {
+ echo call_user_func(
+ array( $this, '_column_' . $column_name ),
+ $item,
+ $classes,
+ $data,
+ $primary
+ );
+ } elseif ( method_exists( $this, 'column_' . $column_name ) ) {
echo "<td $attributes>";
echo call_user_func( array( $this, 'column_' . $column_name ), $item );
+ echo $this->handle_row_actions( $item, $column_name, $primary );
echo "</td>";
- }
- else {
+ } else {
echo "<td $attributes>";
echo $this->column_default( $item, $column_name );
+ echo $this->handle_row_actions( $item, $column_name, $primary );
echo "</td>";
}
}
}
/**
+ * Generates and display row actions links for the list table.
+ *
+ * @since 4.3.0
+ *
+ * @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 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>' : '';
+ }
+
+ /**
* Handle an incoming ajax request (called from admin-ajax.php)
*
* @since 3.1.0
- * @access public
*/
public function ajax_response() {
$this->prepare_items();
@@ -1110,7 +1293,7 @@
if ( isset( $this->_pagination_args['total_items'] ) ) {
$response['total_items_i18n'] = sprintf(
- _n( '1 item', '%s items', $this->_pagination_args['total_items'] ),
+ _n( '%s item', '%s items', $this->_pagination_args['total_items'] ),
number_format_i18n( $this->_pagination_args['total_items'] )
);
}
@@ -1125,7 +1308,6 @@
/**
* Send required variables to JavaScript land
*
- * @access public
*/
public function _js_vars() {
$args = array(