Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Administration API: PUM_ListTable class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage List_Table

[5] Fix | Delete

* @since 3.1.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Base class for displaying a list of items in an ajaxified HTML table.

[10] Fix | Delete

[11] Fix | Delete

* @since 3.1.0

[12] Fix | Delete

* @access private

[13] Fix | Delete

[14] Fix | Delete

class PUM_ListTable {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* The current list of items.

[18] Fix | Delete

[19] Fix | Delete

* @since 3.1.0

[20] Fix | Delete

* @var array

[21] Fix | Delete

[22] Fix | Delete

public $items;

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Various information about the current table.

[26] Fix | Delete

[27] Fix | Delete

* @since 3.1.0

[28] Fix | Delete

* @var array

[29] Fix | Delete

[30] Fix | Delete

protected $_args;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Various information needed for displaying the pagination.

[34] Fix | Delete

[35] Fix | Delete

* @since 3.1.0

[36] Fix | Delete

* @var array

[37] Fix | Delete

[38] Fix | Delete

protected $_pagination_args = [];

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* The current screen.

[42] Fix | Delete

[43] Fix | Delete

* @since 3.1.0

[44] Fix | Delete

* @var object

[45] Fix | Delete

[46] Fix | Delete

protected $screen;

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Cached bulk actions.

[50] Fix | Delete

[51] Fix | Delete

* @since 3.1.0

[52] Fix | Delete

* @var array

[53] Fix | Delete

[54] Fix | Delete

private $_actions;

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Cached pagination output.

[58] Fix | Delete

[59] Fix | Delete

* @since 3.1.0

[60] Fix | Delete

* @var string

[61] Fix | Delete

[62] Fix | Delete

private $_pagination;

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* The view switcher modes.

[66] Fix | Delete

[67] Fix | Delete

* @since 4.1.0

[68] Fix | Delete

* @var array

[69] Fix | Delete

[70] Fix | Delete

protected $modes = [];

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Stores the value returned by ->get_column_info().

[74] Fix | Delete

[75] Fix | Delete

* @since 4.1.0

[76] Fix | Delete

* @var array

[77] Fix | Delete

[78] Fix | Delete

protected $_column_headers;

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* {@internal Missing Summary}

[82] Fix | Delete

[83] Fix | Delete

* @var array

[84] Fix | Delete

[85] Fix | Delete

protected $compat_fields = [ '_args', '_pagination_args', 'screen', '_actions', '_pagination' ];

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* {@internal Missing Summary}

[89] Fix | Delete

[90] Fix | Delete

* @var array

[91] Fix | Delete

[92] Fix | Delete

protected $compat_methods = [

[93] Fix | Delete

'set_pagination_args',

[94] Fix | Delete

'get_views',

[95] Fix | Delete

'get_bulk_actions',

[96] Fix | Delete

'bulk_actions',

[97] Fix | Delete

'row_actions',

[98] Fix | Delete

'months_dropdown',

[99] Fix | Delete

'view_switcher',

[100] Fix | Delete

'comments_bubble',

[101] Fix | Delete

'get_items_per_page',

[102] Fix | Delete

'pagination',

[103] Fix | Delete

'get_sortable_columns',

[104] Fix | Delete

'get_column_info',

[105] Fix | Delete

'get_table_classes',

[106] Fix | Delete

'display_tablenav',

[107] Fix | Delete

'extra_tablenav',

[108] Fix | Delete

'single_row_columns',

[109] Fix | Delete

];

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Constructor.

[113] Fix | Delete

[114] Fix | Delete

* The child class should call this constructor from its own constructor to override

[115] Fix | Delete

* the default $args.

[116] Fix | Delete

[117] Fix | Delete

* @since 3.1.0

[118] Fix | Delete

[119] Fix | Delete

* @param array|string $args {

[120] Fix | Delete

* Array or string of arguments.

[121] Fix | Delete

[122] Fix | Delete

* @type string $plural Plural value used for labels and the objects being listed.

[123] Fix | Delete

* This affects things such as CSS class-names and nonces used

[124] Fix | Delete

* in the list table, e.g. 'posts'. Default empty.

[125] Fix | Delete

* @type string $singular Singular label for an object being listed, e.g. 'post'.

[126] Fix | Delete

* Default empty

[127] Fix | Delete

* @type bool $ajax Whether the list table supports Ajax. This includes loading

[128] Fix | Delete

* and sorting data, for example. If true, the class will call

[129] Fix | Delete

* the _js_vars() method in the footer to provide variables

[130] Fix | Delete

* to any scripts handling Ajax events. Default false.

[131] Fix | Delete

* @type string $screen String containing the hook name used to determine the current

[132] Fix | Delete

* screen. If left null, the current screen will be automatically set.

[133] Fix | Delete

* Default null.

[134] Fix | Delete

* }

[135] Fix | Delete

[136] Fix | Delete

public function __construct( $args = [] ) {

[137] Fix | Delete

$args = wp_parse_args(

[138] Fix | Delete

$args,

[139] Fix | Delete

[

[140] Fix | Delete

'plural' => '',

[141] Fix | Delete

'singular' => '',

[142] Fix | Delete

'ajax' => false,

[143] Fix | Delete

'screen' => null,

[144] Fix | Delete

]

[145] Fix | Delete

);

[146] Fix | Delete

[147] Fix | Delete

$this->screen = convert_to_screen( $args['screen'] );

[148] Fix | Delete

[149] Fix | Delete

add_filter( "manage_{$this->screen->id}_columns", [ $this, 'get_columns' ], 0 );

[150] Fix | Delete

[151] Fix | Delete

if ( ! $args['plural'] ) {

[152] Fix | Delete

$args['plural'] = $this->screen->base;

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

$args['plural'] = sanitize_key( $args['plural'] );

[156] Fix | Delete

$args['singular'] = sanitize_key( $args['singular'] );

[157] Fix | Delete

[158] Fix | Delete

$this->_args = $args;

[159] Fix | Delete

[160] Fix | Delete

if ( $args['ajax'] ) {

[161] Fix | Delete

// wp_enqueue_script( 'list-table' );

[162] Fix | Delete

add_action( 'admin_footer', [ $this, '_js_vars' ] );

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

if ( empty( $this->modes ) ) {

[166] Fix | Delete

$this->modes = [

[167] Fix | Delete

'list' => __( 'List View' ),

[168] Fix | Delete

'excerpt' => __( 'Excerpt View' ),

[169] Fix | Delete

];

[170] Fix | Delete

}

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Make private properties readable for backward compatibility.

[175] Fix | Delete

[176] Fix | Delete

* @since 4.0.0

[177] Fix | Delete

[178] Fix | Delete

* @param string $name Property to get.

[179] Fix | Delete

* @return mixed Property.

[180] Fix | Delete

[181] Fix | Delete

public function __get( $name ) {

[182] Fix | Delete

if ( in_array( $name, $this->compat_fields ) ) {

[183] Fix | Delete

return $this->$name;

[184] Fix | Delete

}

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Make private properties settable for backward compatibility.

[189] Fix | Delete

[190] Fix | Delete

* @since 4.0.0

[191] Fix | Delete

[192] Fix | Delete

* @param string $name Property to check if set.

[193] Fix | Delete

* @param mixed $value Property value.

[194] Fix | Delete

* @return mixed Newly-set property.

[195] Fix | Delete

[196] Fix | Delete

public function __set( $name, $value ) {

[197] Fix | Delete

if ( in_array( $name, $this->compat_fields ) ) {

[198] Fix | Delete

return $this->$name = $value;

[199] Fix | Delete

}

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Make private properties checkable for backward compatibility.

[204] Fix | Delete

[205] Fix | Delete

* @since 4.0.0

[206] Fix | Delete

[207] Fix | Delete

* @param string $name Property to check if set.

[208] Fix | Delete

* @return bool Whether the property is set.

[209] Fix | Delete

[210] Fix | Delete

public function __isset( $name ) {

[211] Fix | Delete

if ( in_array( $name, $this->compat_fields ) ) {

[212] Fix | Delete

return isset( $this->$name );

[213] Fix | Delete

}

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

/**

[217] Fix | Delete

* Make private properties un-settable for backward compatibility.

[218] Fix | Delete

[219] Fix | Delete

* @since 4.0.0

[220] Fix | Delete

[221] Fix | Delete

* @param string $name Property to unset.

[222] Fix | Delete

[223] Fix | Delete

public function __unset( $name ) {

[224] Fix | Delete

if ( in_array( $name, $this->compat_fields ) ) {

[225] Fix | Delete

unset( $this->$name );

[226] Fix | Delete

}

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* Make private/protected methods readable for backward compatibility.

[231] Fix | Delete

[232] Fix | Delete

* @since 4.0.0

[233] Fix | Delete

[234] Fix | Delete

* @param callable $name Method to call.

[235] Fix | Delete

* @param array $arguments Arguments to pass when calling.

[236] Fix | Delete

* @return mixed|bool Return value of the callback, false otherwise.

[237] Fix | Delete

[238] Fix | Delete

public function __call( $name, $arguments ) {

[239] Fix | Delete

if ( in_array( $name, $this->compat_methods ) ) {

[240] Fix | Delete

return call_user_func_array( [ $this, $name ], $arguments );

[241] Fix | Delete

}

[242] Fix | Delete

return false;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Checks the current user's permissions

[247] Fix | Delete

[248] Fix | Delete

* @since 3.1.0

[249] Fix | Delete

* @abstract

[250] Fix | Delete

[251] Fix | Delete

public function ajax_user_can() {

[252] Fix | Delete

die( 'function PUM_ListTable::ajax_user_can() must be over-ridden in a sub-class.' );

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Prepares the list of items for displaying.

[257] Fix | Delete

[258] Fix | Delete

* @uses PUM_ListTable::set_pagination_args()

[259] Fix | Delete

[260] Fix | Delete

* @since 3.1.0

[261] Fix | Delete

* @abstract

[262] Fix | Delete

[263] Fix | Delete

public function prepare_items() {

[264] Fix | Delete

die( 'function PUM_ListTable::prepare_items() must be over-ridden in a sub-class.' );

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

/**

[268] Fix | Delete

* An internal method that sets all the necessary pagination arguments

[269] Fix | Delete

[270] Fix | Delete

* @since 3.1.0

[271] Fix | Delete

[272] Fix | Delete

* @param array|string $args Array or string of arguments with information about the pagination.

[273] Fix | Delete

[274] Fix | Delete

protected function set_pagination_args( $args ) {

[275] Fix | Delete

$args = wp_parse_args(

[276] Fix | Delete

$args,

[277] Fix | Delete

[

[278] Fix | Delete

'total_items' => 0,

[279] Fix | Delete

'total_pages' => 0,

[280] Fix | Delete

'per_page' => 0,

[281] Fix | Delete

]

[282] Fix | Delete

);

[283] Fix | Delete

[284] Fix | Delete

if ( ! $args['total_pages'] && $args['per_page'] > 0 ) {

[285] Fix | Delete

$args['total_pages'] = ceil( $args['total_items'] / $args['per_page'] );

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

// Redirect if page number is invalid and headers are not already sent.

[289] Fix | Delete

if ( ! headers_sent() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX ) && $args['total_pages'] > 0 && $this->get_pagenum() > $args['total_pages'] ) {

[290] Fix | Delete

wp_safe_redirect( add_query_arg( 'paged', $args['total_pages'] ) );

[291] Fix | Delete

exit;

[292] Fix | Delete

}

[293] Fix | Delete

[294] Fix | Delete

$this->_pagination_args = $args;

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete

/**

[298] Fix | Delete

* Access the pagination args.

[299] Fix | Delete

[300] Fix | Delete

* @since 3.1.0

[301] Fix | Delete

[302] Fix | Delete

* @param string $key Pagination argument to retrieve. Common values include 'total_items',

[303] Fix | Delete

* 'total_pages', 'per_page', or 'infinite_scroll'.

[304] Fix | Delete

* @return int Number of items that correspond to the given pagination argument.

[305] Fix | Delete

[306] Fix | Delete

public function get_pagination_arg( $key ) {

[307] Fix | Delete

if ( 'page' === $key ) {

[308] Fix | Delete

return $this->get_pagenum();

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete

if ( isset( $this->_pagination_args[ $key ] ) ) {

[312] Fix | Delete

return $this->_pagination_args[ $key ];

[313] Fix | Delete

}

[314] Fix | Delete

}

[315] Fix | Delete

[316] Fix | Delete

/**

[317] Fix | Delete

* Whether the table has items to display or not

[318] Fix | Delete

[319] Fix | Delete

* @since 3.1.0

[320] Fix | Delete

[321] Fix | Delete

* @return bool

[322] Fix | Delete

[323] Fix | Delete

public function has_items() {

[324] Fix | Delete

return ! empty( $this->items );

[325] Fix | Delete

}

[326] Fix | Delete

[327] Fix | Delete

/**

[328] Fix | Delete

* Message to be displayed when there are no items

[329] Fix | Delete

[330] Fix | Delete

* @since 3.1.0

[331] Fix | Delete

[332] Fix | Delete

public function no_items() {

[333] Fix | Delete

_e( 'No items found.' );

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

/**

[337] Fix | Delete

* Displays the search box.

[338] Fix | Delete

[339] Fix | Delete

* @since 3.1.0

[340] Fix | Delete

[341] Fix | Delete

* @param string $text The 'submit' button label.

[342] Fix | Delete

* @param string $input_id ID attribute value for the search input field.

[343] Fix | Delete

[344] Fix | Delete

public function search_box( $text, $input_id ) {

[345] Fix | Delete

if ( empty( $_REQUEST['s'] ) && ! $this->has_items() ) {

[346] Fix | Delete

return;

[347] Fix | Delete

}

[348] Fix | Delete

[349] Fix | Delete

$input_id = $input_id . '-search-input';

[350] Fix | Delete

[351] Fix | Delete

if ( ! empty( $_REQUEST['orderby'] ) ) {

[352] Fix | Delete

echo '<input type="hidden" name="orderby" value="' . esc_attr( $_REQUEST['orderby'] ) . '" />';

[353] Fix | Delete

}

[354] Fix | Delete

if ( ! empty( $_REQUEST['order'] ) ) {

[355] Fix | Delete

echo '<input type="hidden" name="order" value="' . esc_attr( $_REQUEST['order'] ) . '" />';

[356] Fix | Delete

}

[357] Fix | Delete

if ( ! empty( $_REQUEST['post_mime_type'] ) ) {

[358] Fix | Delete

echo '<input type="hidden" name="post_mime_type" value="' . esc_attr( $_REQUEST['post_mime_type'] ) . '" />';

[359] Fix | Delete

}

[360] Fix | Delete

if ( ! empty( $_REQUEST['detached'] ) ) {

[361] Fix | Delete

echo '<input type="hidden" name="detached" value="' . esc_attr( $_REQUEST['detached'] ) . '" />';

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

[365] Fix | Delete

[366] Fix | Delete

<input type="search" id="<?php echo esc_attr( $input_id ); ?>" name="s" value="<?php _admin_search_query(); ?>" />

[367] Fix | Delete

<?php submit_button( $text, '', '', false, [ 'id' => 'search-submit' ] ); ?>

[368] Fix | Delete

</p>

[369] Fix | Delete

<?php

[370] Fix | Delete

}

[371] Fix | Delete

[372] Fix | Delete

/**

[373] Fix | Delete

* Get an associative array ( id => link ) with the list

[374] Fix | Delete

* of views available on this table.

[375] Fix | Delete

[376] Fix | Delete

* @since 3.1.0

[377] Fix | Delete

[378] Fix | Delete

* @return array

[379] Fix | Delete

[380] Fix | Delete

protected function get_views() {

[381] Fix | Delete

return [];

[382] Fix | Delete

}

[383] Fix | Delete

[384] Fix | Delete

/**

[385] Fix | Delete

* Display the list of views available on this table.

[386] Fix | Delete

[387] Fix | Delete

* @since 3.1.0

[388] Fix | Delete

[389] Fix | Delete

public function views() {

[390] Fix | Delete

$views = $this->get_views();

[391] Fix | Delete

/**

[392] Fix | Delete

* Filters the list of available list table views.

[393] Fix | Delete

[394] Fix | Delete

* The dynamic portion of the hook name, `$this->screen->id`, refers

[395] Fix | Delete

* to the ID of the current screen, usually a string.

[396] Fix | Delete

[397] Fix | Delete

* @since 3.5.0

[398] Fix | Delete

[399] Fix | Delete

* @param array $views An array of available list table views.

[400] Fix | Delete

[401] Fix | Delete

$views = apply_filters( "views_{$this->screen->id}", $views );

[402] Fix | Delete

[403] Fix | Delete

if ( empty( $views ) ) {

[404] Fix | Delete

return;

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete

$this->screen->render_screen_reader_content( 'heading_views' );

[408] Fix | Delete

[409] Fix | Delete

echo "<ul class='subsubsub'>\n";

[410] Fix | Delete

foreach ( $views as $class => $view ) {

[411] Fix | Delete

$views[ $class ] = "\t<li class='$class'>$view";

[412] Fix | Delete

}

[413] Fix | Delete

echo implode( " |</li>\n", $views ) . "</li>\n";

[414] Fix | Delete

echo '</ul>';

[415] Fix | Delete

}

[416] Fix | Delete

[417] Fix | Delete

/**

[418] Fix | Delete

* Get an associative array ( option_name => option_title ) with the list

[419] Fix | Delete

* of bulk actions available on this table.

[420] Fix | Delete

[421] Fix | Delete

* @since 3.1.0

[422] Fix | Delete

[423] Fix | Delete

* @return array

[424] Fix | Delete

[425] Fix | Delete

protected function get_bulk_actions() {

[426] Fix | Delete

return [];

[427] Fix | Delete

}

[428] Fix | Delete

[429] Fix | Delete

/**

[430] Fix | Delete

* Display the bulk actions dropdown.

[431] Fix | Delete

[432] Fix | Delete

* @since 3.1.0

[433] Fix | Delete

[434] Fix | Delete

* @param string $which The location of the bulk actions: 'top' or 'bottom'.

[435] Fix | Delete

* This is designated as optional for backward compatibility.

[436] Fix | Delete

[437] Fix | Delete

protected function bulk_actions( $which = '' ) {

[438] Fix | Delete

if ( is_null( $this->_actions ) ) {

[439] Fix | Delete

$this->_actions = $this->get_bulk_actions();

[440] Fix | Delete

/**

[441] Fix | Delete

* Filters the list table Bulk Actions drop-down.

[442] Fix | Delete

[443] Fix | Delete

* The dynamic portion of the hook name, `$this->screen->id`, refers

[444] Fix | Delete

* to the ID of the current screen, usually a string.

[445] Fix | Delete

[446] Fix | Delete

* This filter can currently only be used to remove bulk actions.

[447] Fix | Delete

[448] Fix | Delete

* @since 3.5.0

[449] Fix | Delete

[450] Fix | Delete

* @param array $actions An array of the available bulk actions.

[451] Fix | Delete

[452] Fix | Delete

$this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions );

[453] Fix | Delete

$two = '';

[454] Fix | Delete

} else {

[455] Fix | Delete

$two = '2';

[456] Fix | Delete

}

[457] Fix | Delete

[458] Fix | Delete

if ( empty( $this->_actions ) ) {

[459] Fix | Delete

return;

[460] Fix | Delete

}

[461] Fix | Delete

[462] Fix | Delete

echo '<label for="bulk-action-selector-' . esc_attr( $which ) . '" class="screen-reader-text">' . __( 'Select bulk action' ) . '</label>';

[463] Fix | Delete

echo '<select name="action' . $two . '" id="bulk-action-selector-' . esc_attr( $which ) . "\">\n";

[464] Fix | Delete

echo '<option value="-1">' . __( 'Bulk Actions' ) . "</option>\n";

[465] Fix | Delete

[466] Fix | Delete

foreach ( $this->_actions as $name => $title ) {

[467] Fix | Delete

$class = 'edit' === $name ? ' class="hide-if-no-js"' : '';

[468] Fix | Delete

[469] Fix | Delete

echo "\t" . '<option value="' . $name . '"' . $class . '>' . $title . "</option>\n";

[470] Fix | Delete

}

[471] Fix | Delete

[472] Fix | Delete

echo "</select>\n";

[473] Fix | Delete

[474] Fix | Delete

submit_button( __( 'Apply' ), 'action', '', false, [ 'id' => "doaction$two" ] );

[475] Fix | Delete

echo "\n";

[476] Fix | Delete

}

[477] Fix | Delete

[478] Fix | Delete

/**

[479] Fix | Delete

* Get the current action selected from the bulk actions dropdown.

[480] Fix | Delete

[481] Fix | Delete

* @since 3.1.0

[482] Fix | Delete

[483] Fix | Delete

* @return string|false The action name or False if no action was selected

[484] Fix | Delete

[485] Fix | Delete

public function current_action() {

[486] Fix | Delete

if ( isset( $_REQUEST['filter_action'] ) && ! empty( $_REQUEST['filter_action'] ) ) {

[487] Fix | Delete

return false;

[488] Fix | Delete

}

[489] Fix | Delete

[490] Fix | Delete

if ( isset( $_REQUEST['action'] ) && -1 !== $_REQUEST['action'] ) {

[491] Fix | Delete

return $_REQUEST['action'];

[492] Fix | Delete

}

[493] Fix | Delete

[494] Fix | Delete

if ( isset( $_REQUEST['action2'] ) && -1 !== $_REQUEST['action2'] ) {

[495] Fix | Delete

return $_REQUEST['action2'];

[496] Fix | Delete

}

[497] Fix | Delete

[498] Fix | Delete

return false;

[499] Fix | Delete

12 3