: str_replace(): Passing null to parameter #2 ($replace) of type array|string is deprecated in
* Base class for displaying a list of items in an ajaxified HTML table.
* The current list of items
* Various information about the current table
* Various information needed for displaying the pagination
protected $_pagination_args = array();
* Cached pagination output
* The view switcher modes.
protected $modes = array();
* Stores the value returned by ->get_column_info()
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',
* The child class should call this constructor from its own constructor to override
* @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'.
* @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.
public function __construct( $args = array() ) {
$args = wp_parse_args( $args, array(
$this->screen = convert_to_screen( $args['screen'] );
add_filter( "manage_{$this->screen->id}_columns", array( $this, 'get_columns' ), 0 );
$args['plural'] = $this->screen->base;
$args['plural'] = sanitize_key( $args['plural'] );
$args['singular'] = sanitize_key( $args['singular'] );
// wp_enqueue_script( 'list-table' );
add_action( 'admin_footer', array( $this, '_js_vars' ) );
if ( empty( $this->modes ) ) {
'list' => __( 'List View' ),
'excerpt' => __( 'Excerpt View' )
* Make private properties readable for backwards compatibility.
* @param string $name Property to get.
* @return mixed Property.
public function __get( $name ) {
if ( in_array( $name, $this->compat_fields ) ) {
* Make private properties settable for backwards compatibility.
* @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->compat_fields ) ) {
return $this->$name = $value;
* Make private properties checkable for backwards compatibility.
* @param string $name Property to check if set.
* @return bool Whether the property is set.
public function __isset( $name ) {
if ( in_array( $name, $this->compat_fields ) ) {
return isset( $this->$name );
* Make private properties un-settable for backwards compatibility.
* @param string $name Property to unset.
public function __unset( $name ) {
if ( in_array( $name, $this->compat_fields ) ) {
* Make private/protected methods readable for backwards compatibility.
* @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->compat_methods ) ) {
return call_user_func_array( array( $this, $name ), $arguments );
* Checks the current user's permissions
public function ajax_user_can() {
die( 'function WPCListTable::ajax_user_can() must be over-ridden in a sub-class.' );
* Prepares the list of items for displaying.
* @uses WPCListTable::set_pagination_args()
public function prepare_items() {
die( 'function WPCListTable::prepare_items() must be over-ridden in a sub-class.' );
* An internal method that sets all the necessary pagination arguments
* @param array $args An associative array with information about the pagination
* @param array|string $args
protected function set_pagination_args( $args ) {
$args = wp_parse_args( $args, array(
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.
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'] ) );
$this->_pagination_args = $args;
* Access the pagination args.
* @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 ) {
return $this->get_pagenum();
if ( isset( $this->_pagination_args[$key] ) )
return $this->_pagination_args[$key];
* Whether the table has items to display or not
public function has_items() {
return !empty( $this->items );
* Message to be displayed when there are no items
public function no_items() {
esc_html_e( 'No items found.' );
* Display the search box.
* @param string $text The search button text
* @param string $input_id The search input id
public function search_box( $text, $input_id ) {
if ( empty( $_REQUEST['s'] ) && !$this->has_items() )
$input_id = $input_id . '-search-input';
if ( ! empty( $_REQUEST['orderby'] ) )
echo '<input type="hidden" name="orderby" value="' . esc_attr( sanitize_text_field($_REQUEST['orderby']) ) . '" />';
if ( ! empty( $_REQUEST['order'] ) )
echo '<input type="hidden" name="order" value="' . esc_attr( sanitize_text_field($_REQUEST['order']) ) . '" />';
if ( ! empty( $_REQUEST['post_mime_type'] ) )
echo '<input type="hidden" name="post_mime_type" value="' . esc_attr( sanitize_text_field($_REQUEST['post_mime_type']) ) . '" />';
if ( ! empty( $_REQUEST['detached'] ) )
echo '<input type="hidden" name="detached" value="' . esc_attr( sanitize_text_field($_REQUEST['detached']) ) . '" />';
<label class="screen-reader-text" for="<?php echo esc_attr($input_id) ?>"><?php echo esc_html($text); ?>:</label>
<input type="search" id="<?php echo esc_attr($input_id) ?>" name="s" value="<?php _admin_search_query(); ?>" />
<?php submit_button( $text, 'button', '', false, array('id' => 'search-submit') ); ?>
* Get an associative array ( id => link ) with the list
* of views available on this table.
protected function get_views() {
* Display the list of views available on this table.
public function views() {
$views = $this->get_views();
* Filter 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.
* @param array $views An array of available list table views.
$views = apply_filters( "views_{$this->screen->id}", $views );
echo "<ul class='subsubsub'>\n";
foreach ( $views as $class => $view ) {
$views[ $class ] = "\t<li class='$class'>$view";
echo wp_kses(implode( " |</li>\n", $views ) . "</li>\n", AdminHelper::allowed_html_tags());
* Get an associative array ( option_name => option_title ) with the list
* of bulk actions available on this table.
protected function get_bulk_actions() {
* Display the bulk actions dropdown.
* @param string $which The location of the bulk actions: 'top' or 'bottom'.
* This is designated as optional for backwards-compatibility.
protected function bulk_actions( $which = '' ) {
if ( is_null( $this->_actions ) ) {
$no_new_actions = $this->_actions = $this->get_bulk_actions();
* Filter 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.
* @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 );
if ( empty( $this->_actions ) )
echo "<label for='bulk-action-selector-" . esc_attr( $which ) . "' class='screen-reader-text'>" . esc_html__( 'Select bulk action' ) . "</label>";
echo "<select name='action".esc_attr($two)."' id='bulk-action-selector-" . esc_attr( $which ) . "'>\n";
echo "<option value='-1' selected='selected'>" . esc_html__( 'Bulk Actions' ) . "</option>\n";
foreach ( $this->_actions as $name => $title ) {
$class = 'edit' == $name ? ' class="hide-if-no-js"' : '';
echo "\t<option value='".esc_attr($name)."'".esc_attr($class).">".esc_html($title)."</option>\n";
submit_button( __( 'Apply' ), 'action', '', false, array( 'id' => "doaction$two" ) );
* Get the current action selected from the bulk actions dropdown.
* @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'] ) )
if ( isset( $_REQUEST['action'] ) && -1 != $_REQUEST['action'] )
return sanitize_text_field($_REQUEST['action']);
if ( isset( $_REQUEST['action2'] ) && -1 != $_REQUEST['action2'] )
return sanitize_text_field($_REQUEST['action2']);
* Generate row actions div
* @param array $actions The list of actions
* @param bool $always_visible Whether the actions should be always visible
protected function row_actions( $actions, $always_visible = false ) {
$action_count = count( $actions );
$out = '<div class="' . ( $always_visible ? 'row-actions visible' : 'row-actions' ) . '">';