get_column_info().
*
* @since 4.1.0
* @access protected
* @var array
*/
protected $columnHeaders;
/**
* Cached bulk actions.
*
* @since 3.1.0
* @access private
* @var array
*/
private $_actions;
/**
* Cached pagination output.
*
* @since 3.1.0
* @access private
* @var string
*/
private $_pagination;
/**
* Constructor.
*
* 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 _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.
* }
*/
public function __construct($args = array())
{
$args = wp_parse_args($args, array(
'plural' => '',
'singular' => '',
'ajax' => false,
'screen' => null,
));
$this->screen = convert_to_screen($args['screen']);
add_filter("manage_{$this->screen->id}_columns", [$this, 'getColumns'], 0);
if (!$args['plural']) {
$args['plural'] = $this->screen->base;
}
$args['plural'] = sanitize_key($args['plural']);
$args['singular'] = sanitize_key($args['singular']);
$this->_args = $args;
if ($args['ajax']) {
// wp_enqueue_script( 'list-table' );
add_action('admin_footer', array($this, '_js_vars'));
}
if (empty($this->modes)) {
$this->modes = array(
'list' => __('List View'),
'excerpt' => __('Excerpt View')
);
}
}
/**
* Make private properties readable for backward compatibility.
*
* @since 4.0.0
* @access public
*
* @param string $name Property to get.
* @return mixed Property.
*/
public function __get($name)
{
if (in_array($name, $this->getCompatFields(), false)) {
return $this->$name;
}
return null;
}
/**
* 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.
* @return mixed Newly-set property.
*/
public function __set($name, $value)
{
if (in_array($name, $this->getCompatFields(), false)) {
return $this->$name = $value;
}
return null;
}
public function getCompatFields()
{
return ['_args', '_pagination_args', 'screen', '_actions', '_pagination'];
}
/**
* 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.
*/
public function __isset($name)
{
if (in_array($name, $this->getCompatFields(), false)) {
return isset($this->$name);
}
return false;
}
/**
* Make private properties un-settable for backward compatibility.
*
* @since 4.0.0
* @access public
*
* @param string $name Property to unset.
*/
public function __unset($name)
{
if (in_array($name, $this->getCompatFields(), false)) {
unset($this->$name);
}
}
/**
* 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.
* @return mixed|bool Return value of the callback, false otherwise.
*/
public function __call($name, $arguments)
{
if (in_array($name, $this->getCompatMethods(), false)) {
return call_user_func_array(array($this, $name), $arguments);
}
return false;
}
public function getCompatMethods()
{
return ['setPagination', 'get_views', 'getBulkActions', 'bulk_actions',
'rowActions', 'months_dropdown', 'view_switcher', 'comments_bubble', 'get_items_per_page', 'pagination',
'getSortableColumns', 'get_column_info', 'get_table_classes', 'display_tablenav', 'extra_tablenav',
'single_row_columns'];
}
/**
* Checks the current user's permissions
*
* @since 3.1.0
* @access public
* @abstract
*/
public function ajax_user_can()
{
die('function WP_List_Table::ajax_user_can() must be over-ridden in a sub-class.');
}
/**
* 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) {
return $this->getPagenum();
}
if (isset($this->_pagination_args[$key])) {
return $this->_pagination_args[$key];
}
return null;
}
/**
* Get the current page number
*
* @since 3.1.0
* @access public
*
* @return int
*/
public function getPagenum()
{
$pagenum = isset($_REQUEST['paged']) ? absint($_REQUEST['paged']) : 0;
if (isset($this->_pagination_args['total_pages']) && $pagenum > $this->_pagination_args['total_pages']) {
$pagenum = $this->_pagination_args['total_pages'];
}
return max(1, $pagenum);
}
/**
* Displays the search box.
*
* @since 3.1.0
* @access public
*
* @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()) {
return;
}
$input_id .= '-search-input';
if (!empty($_REQUEST['orderby'])) {
echo '';
}
if (!empty($_REQUEST['order'])) {
echo '';
}
if (!empty($_REQUEST['post_mime_type'])) {
echo '';
}
if (!empty($_REQUEST['detached'])) {
echo '';
}
?>
'search-submit')); ?>
items);
}
/**
* Display the list of views available on this table.
*
* @since 3.1.0
* @access public
*/
public function views()
{
$views = $this->get_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.
*
* @since 3.5.0
*
* @param array $views An array of available list table views.
*/
$views = apply_filters("views_{$this->screen->id}", $views);
if (empty($views)) {
return;
}
$this->screen->render_screen_reader_content('heading_views');
echo "
";
}
/**
* Get an associative array ( id => link ) with the list
* of views available on this table.
*
* @since 3.1.0
* @access protected
*
* @return array
*/
protected function get_views()
{
return array();
}
/**
* Get the current action selected from the bulk actions dropdown.
*
* @since 3.1.0
* @access public
*
* @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'])) {
return false;
}
if (isset($_REQUEST['action']) && '-1' !== $_REQUEST['action']) {
return $_REQUEST['action'];
}
if (isset($_REQUEST['action2']) && '-1' !== $_REQUEST['action2']) {
return $_REQUEST['action2'];
}
return false;
}
/**
* 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 getPrimaryColumn()
{
return $this->getPrimaryColumnName();
}
/**
* Gets the name of the primary column.
*
* @since 4.3.0
* @access protected
*
* @return string The name of the primary column.
*/
protected function getPrimaryColumnName()
{
$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 = $this->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;
}
/**
* 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->getColumns();
$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;
}
/**
* Get a list of columns. The format is:
* 'internal-name' => 'Title'
*
* @since 3.1.0
* @access public
* @abstract
*
* @return array
*/
abstract public function getColumns();
/**
* 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');
?>
print_column_headers(); ?>
>
display_rows_or_placeholder(); ?>
print_column_headers(false); ?>
display_tablenav('bottom');
}
/**
* 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) {
wp_nonce_field('bulk-' . $this->_args['plural']);
}
?>
_actions === null) {
$no_new_actions = $this->_actions = $this->getBulkActions();
/**
* 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.
*
* This filter can currently only be used to remove bulk actions.
*
* @since 3.5.0
*
* @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';
}
if (empty($this->_actions)) {
return;
}
echo '';
echo '\n";
submit_button(__('Apply'), 'action', '', false, array('id' => "doaction$two"));
echo "\n";
}
/**
* Get an associative array ( option_name => option_title ) with the list
* of bulk actions available on this table.
*
* @since 3.1.0
* @access protected
*
* @return array
*/
protected function getBulkActions()
{
return array();
}
/**
* Extra controls to be displayed between bulk actions and pagination
*
* @since 3.1.0
* @access protected
*
* @param string $which
*/
protected function extra_tablenav($which)
{
}
/**
* Display the pagination.
*
* @since 3.1.0
* @access protected
*
* @param string $which
*/
protected function pagination($which)
{
if (empty($this->_pagination_args)) {
return;
}
$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'];
}
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->getPagenum();
$removable_query_args = wp_removable_query_args();
$current_url = set_url_scheme('http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
$current_url = remove_query_arg($removable_query_args, $current_url);
$page_links = array();
$total_pages_before = '';
$total_pages_after = '';
$disable_first = $disable_last = $disable_prev = $disable_next = false;
if ((int)$current === 1) {
$disable_first = true;
$disable_prev = true;
}
if ((int)$current === 2) {
$disable_first = true;
}
if ((int)$current === (int)$total_pages) {
$disable_last = true;
$disable_next = true;
}
if ((int)$current === (int)$total_pages - 1) {
$disable_last = true;
}
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;
$total_pages_before = '' . __('Current Page') . '';
} else {
$html_current_page = sprintf("%s",
'',
$current,
strlen($total_pages)
);
}
$html_total_pages = sprintf("%s", number_format_i18n($total_pages));
$page_links[] = $total_pages_before . sprintf(_x('%1$s of %2$s', 'paging'), $html_current_page, $html_total_pages) . $total_pages_after;
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'),
'›'
);
}
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)) {
$pagination_links_class = ' hide-if-js';
}
$output .= "\n" . implode("\n", $page_links) . '';
$page_class = ' no-pages';
if ($total_pages) {
$page_class = $total_pages < 2 ? ' one-page' : '';
}
$this->_pagination = "
$output
";
echo $this->_pagination;
}
/**
* 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.
*/
protected function get_table_classes()
{
return array('widefat', 'fixed', 'striped', $this->_args['plural']);
}
/**
* 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, $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);
$current_orderby = '';
if (isset($_GET['orderby'])) {
$current_orderby = sanitize_text_field($_GET['orderby']);
}
$current_order = 'asc';
if (isset($_GET['order']) && 'desc' === $_GET['order']) {
$current_order = 'desc';
}
if (!empty($columns['cb'])) {
static $cb_counter = 1;
$columns['cb'] = ''
. '';
$cb_counter++;
}
foreach ($columns as $column_key => $column_display_name) {
$class = array('manage-column', "column-$column_key");
if (in_array($column_key, $hidden, false)) {
$class[] = 'hidden';
}
if ('cb' === $column_key) {
$class[] = 'check-column';
} elseif (in_array($column_key, ['posts', 'comments', 'links'], false)) {
$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';
$class[] = 'sorted';
$class[] = $current_order;
} else {
$order = $desc_first ? 'desc' : 'asc';
$class[] = 'sortable';
$class[] = $desc_first ? 'asc' : 'desc';
}
$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='" . implode(' ', $class) . "'";
}
echo "<$tag $scope $id $class>$column_display_name";
}
}
/**
* 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()
{
// $_column_headers is already set / cached
if ($this->columnHeaders !== null && is_array($this->columnHeaders)) {
// 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.
$columnHeaders = [[], [], [], $this->getPrimaryColumnName()];
foreach ($this->columnHeaders as $key => $value) {
$columnHeaders[$key] = $value;
}
return $columnHeaders;
}
$columns = get_column_headers($this->screen);
$hidden = get_hidden_columns($this->screen);
$sortable_columns = $this->getSortableColumns();
/**
* 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.
*
* @since 3.5.0
*
* @param array $sortable_columns An array of sortable columns.
*/
$_sortable = apply_filters("manage_{$this->screen->id}_sortable_columns", $sortable_columns);
$sortable = array();
foreach ($_sortable as $id => $data) {
if (empty($data)) {
continue;
}
$data = (array)$data;
if (!isset($data[1])) {
$data[1] = false;
}
$sortable[$id] = $data;
}
$primary = $this->getPrimaryColumnName();
$this->columnHeaders = [$columns, $hidden, $sortable, $primary];
return $this->columnHeaders;
}
/**
* Get a list of sortable columns. The format is:
* 'internal-name' => 'orderby'
* or
* 'internal-name' => array( 'orderby', true )
*
* The second format will make the initial sorting order be descending
*
* @since 3.1.0
* @access protected
*
* @return array
*/
abstract protected function getSortableColumns();
/**
* Generate the tbody element for the list table.
*
* @since 3.1.0
* @access public
*/
public function display_rows_or_placeholder()
{
if ($this->has_items()) {
$this->display_rows();
} else {
echo '
';
$this->no_items();
echo '
';
}
}
/**
* Generate the table rows
*
* @since 3.1.0
* @access public
*/
public function display_rows()
{
foreach ($this->items as $item)
$this->single_row($item);
}
/**
* Generates content for a single row of the table
*
* @since 3.1.0
* @access public
*
* @param object $item The current item
*/
public function single_row($item)
{
echo '
';
$this->single_row_columns($item);
echo '
';
}
abstract public function getId($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, , $primary) = $this->get_column_info();
foreach ($columns as $columnName => $column_display_name) {
$classes = "$columnName column-$columnName";
if ($primary === $columnName) {
$classes .= ' has-row-actions column-primary';
}
if (in_array($columnName, $hidden, false)) {
$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='$classes' $data";
if ('cb' === $columnName) {
echo '