$title ) {
+ foreach ( $this->modes as $mode => $title ) {
$classes = array( 'view-' . $mode );
- if ( $current_mode == $mode )
+ if ( $current_mode === $mode )
$classes[] = 'current';
printf(
"
%s \n",
@@ -556,15 +645,46 @@ class WP_List_Table {
* @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();
+
+ $approved_comments_number = number_format_i18n( $approved_comments );
+ $pending_comments_number = number_format_i18n( $pending_comments );
- if ( $pending_comments )
- echo '
';
+ $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 " ";
+ // No comments at all.
+ if ( ! $approved_comments && ! $pending_comments ) {
+ printf( 'â %s ',
+ __( 'No comments' )
+ );
+ // Approved comments have different display depending on some conditions.
+ } elseif ( $approved_comments ) {
+ printf( '%s ',
+ 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( '',
+ $approved_comments_number,
+ $pending_comments ? __( 'No approved comments' ) : __( 'No comments' )
+ );
+ }
- if ( $pending_comments )
- echo ' ';
+ if ( $pending_comments ) {
+ printf( '
%s ',
+ esc_url( add_query_arg( array( 'p' => $post_id, 'comment_status' => 'moderated' ), admin_url( 'edit-comments.php' ) ) ),
+ $pending_comments_number,
+ $pending_phrase
+ );
+ } else {
+ printf( '
%s ',
+ $pending_comments_number,
+ $approved_comments ? __( 'No pending comments' ) : __( 'No comments' )
+ );
+ }
}
/**
@@ -578,7 +698,7 @@ class WP_List_Table {
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 );
@@ -590,6 +710,8 @@ class WP_List_Table {
* @since 3.1.0
* @access protected
*
+ * @param string $option
+ * @param int $default
* @return int
*/
protected function get_items_per_page( $option, $default = 20 ) {
@@ -598,12 +720,13 @@ 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 may include:
- * 'edit_comments_per_page', 'sites_network_per_page', 'site_themes_network_per_page',
- * 'themes_netework_per_page', 'users_network_per_page', 'edit_{$post_type}', etc.
+ * 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',
+ * 'sites_network_per_page', 'site_themes_network_per_page', 'themes_network_per_page',
+ * 'users_network_per_page', 'edit_post_per_page', 'edit_page_per_page',
+ * 'edit_{$post_type}_per_page', etc.
*
* @since 2.9.0
*
@@ -617,6 +740,8 @@ class WP_List_Table {
*
* @since 3.1.0
* @access protected
+ *
+ * @param string $which
*/
protected function pagination( $which ) {
if ( empty( $this->_pagination_args ) ) {
@@ -630,63 +755,93 @@ class WP_List_Table {
$infinite_scroll = $this->_pagination_args['infinite_scroll'];
}
- $output = '
' . sprintf( _n( '1 item', '%s items', $total_items ), number_format_i18n( $total_items ) ) . ' ';
+ if ( 'top' === $which && $total_pages > 1 ) {
+ $this->screen->render_screen_reader_content( 'heading_pagination' );
+ }
+
+ $output = '
' . sprintf( _n( '%s item', '%s items', $total_items ), number_format_i18n( $total_items ) ) . ' ';
$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';
+ $total_pages_before = '
';
+ $total_pages_after = ' ';
+
+ $disable_first = $disable_last = $disable_prev = $disable_next = false;
+
+ if ( $current == 1 ) {
+ $disable_first = true;
+ $disable_prev = true;
+ }
+ if ( $current == 2 ) {
+ $disable_first = true;
}
- if ( $current == $total_pages ) {
- $disable_last = ' disabled';
+ if ( $current == $total_pages ) {
+ $disable_last = true;
+ $disable_next = true;
+ }
+ if ( $current == $total_pages - 1 ) {
+ $disable_last = true;
}
- $page_links[] = sprintf( "
%s ",
- 'first-page' . $disable_first,
- esc_attr__( 'Go to the first page' ),
- esc_url( remove_query_arg( 'paged', $current_url ) ),
- '«'
- );
- $page_links[] = sprintf( "
%s ",
- '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[] = '
« ';
+ } else {
+ $page_links[] = sprintf( "
%s %s ",
+ esc_url( remove_query_arg( 'paged', $current_url ) ),
+ __( 'First page' ),
+ '«'
+ );
+ }
+
+ if ( $disable_prev ) {
+ $page_links[] = '
‹ ';
+ } else {
+ $page_links[] = sprintf( "
%s %s ",
+ esc_url( add_query_arg( 'paged', max( 1, $current-1 ), $current_url ) ),
+ __( 'Previous page' ),
+ '‹'
+ );
+ }
- if ( 'bottom' == $which ) {
- $html_current_page = $current;
+ if ( 'bottom' === $which ) {
+ $html_current_page = $current;
+ $total_pages_before = '
' . __( 'Current Page' ) . ' ';
} else {
- $html_current_page = sprintf( "%s ",
- '' . __( 'Select Page' ) . ' ',
- esc_attr__( 'Current page' ),
+ $html_current_page = sprintf( "%s",
+ '' . __( 'Current Page' ) . ' ',
$current,
strlen( $total_pages )
);
}
$html_total_pages = sprintf( "%s ", number_format_i18n( $total_pages ) );
- $page_links[] = '' . sprintf( _x( '%1$s of %2$s', 'paging' ), $html_current_page, $html_total_pages ) . ' ';
+ $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( "%s ",
- '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[] = '› ';
+ } else {
+ $page_links[] = sprintf( "%s %s ",
+ esc_url( add_query_arg( 'paged', min( $total_pages, $current+1 ), $current_url ) ),
+ __( 'Next page' ),
+ '›'
+ );
+ }
- $page_links[] = sprintf( "%s ",
- '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[] = '» ';
+ } else {
+ $page_links[] = sprintf( "%s %s ",
+ esc_url( add_query_arg( 'paged', $total_pages, $current_url ) ),
+ __( 'Last page' ),
+ '»'
+ );
+ }
$pagination_links_class = 'pagination-links';
if ( ! empty( $infinite_scroll ) ) {
@@ -735,6 +890,83 @@ class WP_List_Table {
return array();
}
+ /**
+ * Gets the name of the default primary column.
+ *
+ * @since 4.3.0
+ * @access protected
+ *
+ * @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
+ * @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.
+ *
+ * @since 4.3.0
+ * @access protected
+ *
+ * @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
*
@@ -744,17 +976,26 @@ class WP_List_Table {
* @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
+ * The dynamic portion of the hook name, `$this->screen->id`, refers
* to the ID of the current screen, usually a string.
*
* @since 3.5.0
@@ -775,7 +1016,8 @@ class WP_List_Table {
$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;
}
@@ -800,23 +1042,27 @@ class WP_List_Table {
* @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;
@@ -828,22 +1074,24 @@ class WP_List_Table {
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;';
-
- $style = ' style="' . $style . '"';
+ if ( in_array( $column_key, $hidden ) ) {
+ $class[] = 'hidden';
+ }
- 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 {
@@ -855,12 +1103,14 @@ class WP_List_Table {
$column_display_name = '' . $column_display_name . ' ';
}
+ $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 " $column_display_name ";
+ echo "<$tag $scope $id $class>$column_display_name$tag>";
}
}
@@ -875,6 +1125,7 @@ class WP_List_Table {
$this->display_tablenav( 'top' );
+ $this->screen->render_screen_reader_content( 'heading_list' );
?>
@@ -883,33 +1134,34 @@ class WP_List_Table {
-
-
- print_column_headers( false ); ?>
-
-
-
>
display_rows_or_placeholder(); ?>
+
+
+
+ print_column_headers( false ); ?>
+
+
+
display_tablenav( 'bottom' );
}
/**
- * Get a list of CSS classes for the
tag
+ * Get a list of CSS classes for the WP_List_Table table tag.
*
* @since 3.1.0
* @access protected
*
- * @return array
+ * @return array List of CSS classes for the table tag.
*/
protected function get_table_classes() {
- return array( 'widefat', 'fixed', $this->_args['plural'] );
+ return array( 'widefat', 'fixed', 'striped', $this->_args['plural'] );
}
/**
@@ -917,17 +1169,20 @@ class WP_List_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'] );
-?>
+ }
+ ?>
+ has_items() ): ?>
bulk_actions( $which ); ?>
-extra_tablenav( $which );
$this->pagination( $which );
?>
@@ -942,11 +1197,13 @@ class WP_List_Table {
*
* @since 3.1.0
* @access protected
+ *
+ * @param string $which
*/
protected function extra_tablenav( $which ) {}
/**
- * Generate the
part of the table
+ * Generate the tbody element for the list table.
*
* @since 3.1.0
* @access public
@@ -981,14 +1238,24 @@ class WP_List_Table {
* @param object $item The current item
*/
public function single_row( $item ) {
- static $row_class = '';
- $row_class = ( $row_class == '' ? ' class="alternate"' : '' );
-
- echo '';
+ echo ' ';
$this->single_row_columns( $item );
echo ' ';
}
+ /**
+ *
+ * @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
*
@@ -998,35 +1265,65 @@ class WP_List_Table {
* @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';
+ }
+
+ if ( in_array( $column_name, $hidden ) ) {
+ $classes .= ' hidden';
+ }
- $style = '';
- if ( in_array( $column_name, $hidden ) )
- $style = ' style="display:none;"';
+ // 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 ) . '"';
- $attributes = "$class$style";
+ $attributes = "class='$classes' $data";
- if ( 'cb' == $column_name ) {
+ if ( 'cb' === $column_name ) {
echo '';
echo $this->column_cb( $item );
echo ' ';
- }
- 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 "";
echo call_user_func( array( $this, 'column_' . $column_name ), $item );
+ echo $this->handle_row_actions( $item, $column_name, $primary );
echo " ";
- }
- else {
+ } else {
echo "";
echo $this->column_default( $item, $column_name );
+ echo $this->handle_row_actions( $item, $column_name, $primary );
echo " ";
}
}
}
+ /**
+ * Generates and display row actions links for the list table.
+ *
+ * @since 4.3.0
+ * @access protected
+ *
+ * @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 ? '' . __( 'Show more details' ) . ' ' : '';
+ }
+
/**
* Handle an incoming ajax request (called from admin-ajax.php)
*
@@ -1049,7 +1346,7 @@ class WP_List_Table {
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'] )
);
}
@@ -1058,7 +1355,7 @@ class WP_List_Table {
$response['total_pages_i18n'] = number_format_i18n( $this->_pagination_args['total_pages'] );
}
- die( json_encode( $response ) );
+ die( wp_json_encode( $response ) );
}
/**
@@ -1075,6 +1372,6 @@ class WP_List_Table {
)
);
- printf( "\n", json_encode( $args ) );
+ printf( "\n", wp_json_encode( $args ) );
}
}