*
* @since 3.1.0
* @var array
- * @access private
+ * @access protected
*/
- private $_args;
+ protected $_args;
/**
* Various information needed for displaying the pagination
*
* @since 3.1.0
* @var array
- * @access private
*/
- private $_pagination_args = array();
+ protected $_pagination_args = array();
/**
* The current screen
*/
protected $modes = array();
+ /**
+ * Stores the value returned by ->get_column_info()
+ *
+ * @var array
+ */
+ protected $_column_headers;
+
+ protected $compat_fields = array( '_args', '_pagination_args', 'screen', '_actions', '_pagination' );
+
+ 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',
+ 'single_row_columns' );
+
/**
* Constructor.
*
* @return mixed Property.
*/
public function __get( $name ) {
- return $this->$name;
+ if ( in_array( $name, $this->compat_fields ) ) {
+ return $this->$name;
+ }
}
/**
* @since 4.0.0
* @access public
*
- * @param string $name Property to set.
+ * @param string $name Property to check if set.
* @param mixed $value Property value.
* @return mixed Newly-set property.
*/
public function __set( $name, $value ) {
- return $this->$name = $value;
+ if ( in_array( $name, $this->compat_fields ) ) {
+ return $this->$name = $value;
+ }
}
/**
* @return bool Whether the property is set.
*/
public function __isset( $name ) {
- return isset( $this->$name );
+ if ( in_array( $name, $this->compat_fields ) ) {
+ return isset( $this->$name );
+ }
}
/**
* @param string $name Property to unset.
*/
public function __unset( $name ) {
- unset( $this->$name );
+ if ( in_array( $name, $this->compat_fields ) ) {
+ unset( $this->$name );
+ }
}
/**
* @return mixed|bool Return value of the callback, false otherwise.
*/
public function __call( $name, $arguments ) {
- return call_user_func_array( array( $this, $name ), $arguments );
+ if ( in_array( $name, $this->compat_methods ) ) {
+ return call_user_func_array( array( $this, $name ), $arguments );
+ }
+ return false;
}
/**
*
* @param array $args An associative array with information about the pagination
* @access protected
+ *
+ * @param array|string $args
*/
protected function set_pagination_args( $args ) {
$args = wp_parse_args( $args, array(
<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, false, array('id' => 'search-submit') ); ?>
+ <?php submit_button( $text, 'button', '', false, array('id' => 'search-submit') ); ?>
</p>
<?php
}
echo "</select>\n";
- submit_button( __( 'Apply' ), 'action', false, false, array( 'id' => "doaction$two" ) );
+ submit_button( __( 'Apply' ), 'action', '', false, array( 'id' => "doaction$two" ) );
echo "\n";
}
* @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'] ) )
}
$out .= '</div>';
+ $out .= '<button type="button" class="toggle-row"><span class="screen-reader-text">' . __( 'Show more details' ) . '</span></button>';
+
return $out;
}
* @since 3.1.0
* @access protected
*
+ * @global wpdb $wpdb
+ * @global WP_Locale $wp_locale
+ *
* @param string $post_type
*/
protected function months_dropdown( $post_type ) {
global $wpdb, $wp_locale;
+ /**
+ * Filter whether to remove the 'Months' drop-down from the post list table.
+ *
+ * @since 4.2.0
+ *
+ * @param bool $disable Whether to disable the drop-down. Default false.
+ * @param string $post_type The post type.
+ */
+ if ( apply_filters( 'disable_months_dropdown', false, $post_type ) ) {
+ return;
+ }
+
$months = $wpdb->get_results( $wpdb->prepare( "
SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month
FROM $wpdb->posts
* @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 );
- 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>";
+ $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 );
- if ( $pending_comments )
- echo '</strong>';
+ // 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 ) {
+ 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
+ );
+ }
}
/**
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 );
$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>';
+ $output = '<span class="displaying-num">' . sprintf( _n( '%s item', '%s items', $total_items ), number_format_i18n( $total_items ) ) . '</span>';
$current = $this->get_pagenum();
$page_links = array();
- $disable_first = $disable_last = '';
- if ( $current == 1 ) {
- $disable_first = ' disabled';
+ $total_pages_before = '<span class="paging-input">';
+ $total_pages_after = '</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;
}
- 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( "<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 ) ),
- '«'
- );
- $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 ( $disable_prev ) {
+ $page_links[] = '<span class="tablenav-pages-navspan" aria-hidden="true">‹</span>';
+ } else {
+ $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;
+ $html_current_page = $current;
+ $total_pages_before = '<span class="screen-reader-text">' . __( 'Current Page' ) . '</span><span id="table-paging" class="paging-input">';
} 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' ),
+ $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' />",
+ '<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 ) ) {
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 = '';
+
+ // 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;
+ }
+
+ /**
+ * 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 = $this->get_columns();
+ $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();
+ }
+
+ /**
+ * Filter 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
*
* @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[$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;
}
* @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 );
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 )
$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];
$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>";
}
}
$singular = $this->_args['singular'];
$this->display_tablenav( 'top' );
-
?>
<table class="wp-list-table <?php echo implode( ' ', $this->get_table_classes() ); ?>">
<thead>
</tr>
</thead>
- <tfoot>
- <tr>
- <?php $this->print_column_headers( false ); ?>
- </tr>
- </tfoot>
-
<tbody id="the-list"<?php
if ( $singular ) {
echo " data-wp-lists='list:$singular'";
} ?>>
<?php $this->display_rows_or_placeholder(); ?>
</tbody>
+
+ <tfoot>
+ <tr>
+ <?php $this->print_column_headers( false ); ?>
+ </tr>
+ </tfoot>
+
</table>
<?php
$this->display_tablenav( 'bottom' );
* @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'] );
}
/**
* @param object $item The current item
*/
public function single_row( $item ) {
- static $row_class = '';
- $row_class = ( $row_class == '' ? ' class="alternate"' : '' );
-
- echo '<tr' . $row_class . '>';
+ echo '<tr>';
$this->single_row_columns( $item );
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
*
* @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';
+ }
+
+ // 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 ) {
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
+ * @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 output. In this case, an empty string.
+ */
+ 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)
*
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'] )
);
}