Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Administration API: WP_List_Table 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

[13] Fix | Delete

#[AllowDynamicProperties]

[14] Fix | Delete

class WP_List_Table {

[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 = array();

[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 WP_Screen

[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 = array();

[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 = array( '_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 = array(

[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 = array() ) {

[137] Fix | Delete

$args = wp_parse_args(

[138] Fix | Delete

$args,

[139] Fix | Delete

array(

[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", array( $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', array( $this, '_js_vars' ) );

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

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

[166] Fix | Delete

$this->modes = array(

[167] Fix | Delete

'list' => __( 'Compact view' ),

[168] Fix | Delete

'excerpt' => __( 'Extended view' ),

[169] Fix | Delete

);

[170] Fix | Delete

}

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Makes private properties readable for backward compatibility.

[175] Fix | Delete

[176] Fix | Delete

* @since 4.0.0

[177] Fix | Delete

* @since 6.4.0 Getting a dynamic property is deprecated.

[178] Fix | Delete

[179] Fix | Delete

* @param string $name Property to get.

[180] Fix | Delete

* @return mixed Property.

[181] Fix | Delete

[182] Fix | Delete

public function __get( $name ) {

[183] Fix | Delete

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

[184] Fix | Delete

return $this->$name;

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

wp_trigger_error(

[188] Fix | Delete

__METHOD__,

[189] Fix | Delete

"The property `{$name}` is not declared. Getting a dynamic property is " .

[190] Fix | Delete

'deprecated since version 6.4.0! Instead, declare the property on the class.',

[191] Fix | Delete

E_USER_DEPRECATED

[192] Fix | Delete

);

[193] Fix | Delete

return null;

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* Makes private properties settable for backward compatibility.

[198] Fix | Delete

[199] Fix | Delete

* @since 4.0.0

[200] Fix | Delete

* @since 6.4.0 Setting a dynamic property is deprecated.

[201] Fix | Delete

[202] Fix | Delete

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

[203] Fix | Delete

* @param mixed $value Property value.

[204] Fix | Delete

[205] Fix | Delete

public function __set( $name, $value ) {

[206] Fix | Delete

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

[207] Fix | Delete

$this->$name = $value;

[208] Fix | Delete

return;

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

wp_trigger_error(

[212] Fix | Delete

__METHOD__,

[213] Fix | Delete

"The property `{$name}` is not declared. Setting a dynamic property is " .

[214] Fix | Delete

'deprecated since version 6.4.0! Instead, declare the property on the class.',

[215] Fix | Delete

E_USER_DEPRECATED

[216] Fix | Delete

);

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

/**

[220] Fix | Delete

* Makes private properties checkable for backward compatibility.

[221] Fix | Delete

[222] Fix | Delete

* @since 4.0.0

[223] Fix | Delete

* @since 6.4.0 Checking a dynamic property is deprecated.

[224] Fix | Delete

[225] Fix | Delete

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

[226] Fix | Delete

* @return bool Whether the property is a back-compat property and it is set.

[227] Fix | Delete

[228] Fix | Delete

public function __isset( $name ) {

[229] Fix | Delete

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

[230] Fix | Delete

return isset( $this->$name );

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

wp_trigger_error(

[234] Fix | Delete

__METHOD__,

[235] Fix | Delete

"The property `{$name}` is not declared. Checking `isset()` on a dynamic property " .

[236] Fix | Delete

'is deprecated since version 6.4.0! Instead, declare the property on the class.',

[237] Fix | Delete

E_USER_DEPRECATED

[238] Fix | Delete

);

[239] Fix | Delete

return false;

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

/**

[243] Fix | Delete

* Makes private properties un-settable for backward compatibility.

[244] Fix | Delete

[245] Fix | Delete

* @since 4.0.0

[246] Fix | Delete

* @since 6.4.0 Unsetting a dynamic property is deprecated.

[247] Fix | Delete

[248] Fix | Delete

* @param string $name Property to unset.

[249] Fix | Delete

[250] Fix | Delete

public function __unset( $name ) {

[251] Fix | Delete

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

[252] Fix | Delete

unset( $this->$name );

[253] Fix | Delete

return;

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

wp_trigger_error(

[257] Fix | Delete

__METHOD__,

[258] Fix | Delete

"A property `{$name}` is not declared. Unsetting a dynamic property is " .

[259] Fix | Delete

'deprecated since version 6.4.0! Instead, declare the property on the class.',

[260] Fix | Delete

E_USER_DEPRECATED

[261] Fix | Delete

);

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

/**

[265] Fix | Delete

* Makes private/protected methods readable for backward compatibility.

[266] Fix | Delete

[267] Fix | Delete

* @since 4.0.0

[268] Fix | Delete

[269] Fix | Delete

* @param string $name Method to call.

[270] Fix | Delete

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

[271] Fix | Delete

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

[272] Fix | Delete

[273] Fix | Delete

public function __call( $name, $arguments ) {

[274] Fix | Delete

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

[275] Fix | Delete

return $this->$name( ...$arguments );

[276] Fix | Delete

}

[277] Fix | Delete

return false;

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

/**

[281] Fix | Delete

* Checks the current user's permissions

[282] Fix | Delete

[283] Fix | Delete

* @since 3.1.0

[284] Fix | Delete

* @abstract

[285] Fix | Delete

[286] Fix | Delete

public function ajax_user_can() {

[287] Fix | Delete

die( 'function WP_List_Table::ajax_user_can() must be overridden in a subclass.' );

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

/**

[291] Fix | Delete

* Prepares the list of items for displaying.

[292] Fix | Delete

[293] Fix | Delete

* @uses WP_List_Table::set_pagination_args()

[294] Fix | Delete

[295] Fix | Delete

* @since 3.1.0

[296] Fix | Delete

* @abstract

[297] Fix | Delete

[298] Fix | Delete

public function prepare_items() {

[299] Fix | Delete

die( 'function WP_List_Table::prepare_items() must be overridden in a subclass.' );

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

/**

[303] Fix | Delete

* Sets all the necessary pagination arguments.

[304] Fix | Delete

[305] Fix | Delete

* @since 3.1.0

[306] Fix | Delete

[307] Fix | Delete

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

[308] Fix | Delete

[309] Fix | Delete

protected function set_pagination_args( $args ) {

[310] Fix | Delete

$args = wp_parse_args(

[311] Fix | Delete

$args,

[312] Fix | Delete

array(

[313] Fix | Delete

'total_items' => 0,

[314] Fix | Delete

'total_pages' => 0,

[315] Fix | Delete

'per_page' => 0,

[316] Fix | Delete

)

[317] Fix | Delete

);

[318] Fix | Delete

[319] Fix | Delete

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

[320] Fix | Delete

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

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

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

[324] Fix | Delete

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

[325] Fix | Delete

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

[326] Fix | Delete

exit;

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

$this->_pagination_args = $args;

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

/**

[333] Fix | Delete

* Access the pagination args.

[334] Fix | Delete

[335] Fix | Delete

* @since 3.1.0

[336] Fix | Delete

[337] Fix | Delete

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

[338] Fix | Delete

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

[339] Fix | Delete

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

[340] Fix | Delete

[341] Fix | Delete

public function get_pagination_arg( $key ) {

[342] Fix | Delete

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

[343] Fix | Delete

return $this->get_pagenum();

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

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

[347] Fix | Delete

return $this->_pagination_args[ $key ];

[348] Fix | Delete

}

[349] Fix | Delete

[350] Fix | Delete

return 0;

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* Determines whether the table has items to display or not

[355] Fix | Delete

[356] Fix | Delete

* @since 3.1.0

[357] Fix | Delete

[358] Fix | Delete

* @return bool

[359] Fix | Delete

[360] Fix | Delete

public function has_items() {

[361] Fix | Delete

return ! empty( $this->items );

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

/**

[365] Fix | Delete

* Message to be displayed when there are no items

[366] Fix | Delete

[367] Fix | Delete

* @since 3.1.0

[368] Fix | Delete

[369] Fix | Delete

public function no_items() {

[370] Fix | Delete

_e( 'No items found.' );

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete

/**

[374] Fix | Delete

* Displays the search box.

[375] Fix | Delete

[376] Fix | Delete

* @since 3.1.0

[377] Fix | Delete

[378] Fix | Delete

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

[379] Fix | Delete

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

[380] Fix | Delete

[381] Fix | Delete

public function search_box( $text, $input_id ) {

[382] Fix | Delete

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

[383] Fix | Delete

return;

[384] Fix | Delete

}

[385] Fix | Delete

[386] Fix | Delete

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

[387] Fix | Delete

[388] Fix | Delete

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

[389] Fix | Delete

if ( is_array( $_REQUEST['orderby'] ) ) {

[390] Fix | Delete

foreach ( $_REQUEST['orderby'] as $key => $value ) {

[391] Fix | Delete

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

[392] Fix | Delete

}

[393] Fix | Delete

} else {

[394] Fix | Delete

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

[395] Fix | Delete

}

[396] Fix | Delete

}

[397] Fix | Delete

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

[398] Fix | Delete

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

[399] Fix | Delete

}

[400] Fix | Delete

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

[401] Fix | Delete

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

[402] Fix | Delete

}

[403] Fix | Delete

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

[404] Fix | Delete

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

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete

[408] Fix | Delete

[409] Fix | Delete

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

[410] Fix | Delete

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

[411] Fix | Delete

</p>

[412] Fix | Delete

<?php

[413] Fix | Delete

}

[414] Fix | Delete

[415] Fix | Delete

/**

[416] Fix | Delete

* Generates views links.

[417] Fix | Delete

[418] Fix | Delete

* @since 6.1.0

[419] Fix | Delete

[420] Fix | Delete

* @param array $link_data {

[421] Fix | Delete

* An array of link data.

[422] Fix | Delete

[423] Fix | Delete

* @type string $url The link URL.

[424] Fix | Delete

* @type string $label The link label.

[425] Fix | Delete

* @type bool $current Optional. Whether this is the currently selected view.

[426] Fix | Delete

* }

[427] Fix | Delete

* @return string[] An array of link markup. Keys match the `$link_data` input array.

[428] Fix | Delete

[429] Fix | Delete

protected function get_views_links( $link_data = array() ) {

[430] Fix | Delete

if ( ! is_array( $link_data ) ) {

[431] Fix | Delete

_doing_it_wrong(

[432] Fix | Delete

__METHOD__,

[433] Fix | Delete

sprintf(

[434] Fix | Delete

/* translators: %s: The $link_data argument. */

[435] Fix | Delete

__( 'The %s argument must be an array.' ),

[436] Fix | Delete

'<code>$link_data</code>'

[437] Fix | Delete

[438] Fix | Delete

'6.1.0'

[439] Fix | Delete

);

[440] Fix | Delete

[441] Fix | Delete

return array( '' );

[442] Fix | Delete

}

[443] Fix | Delete

[444] Fix | Delete

$views_links = array();

[445] Fix | Delete

[446] Fix | Delete

foreach ( $link_data as $view => $link ) {

[447] Fix | Delete

if ( empty( $link['url'] ) || ! is_string( $link['url'] ) || '' === trim( $link['url'] ) ) {

[448] Fix | Delete

_doing_it_wrong(

[449] Fix | Delete

__METHOD__,

[450] Fix | Delete

sprintf(

[451] Fix | Delete

/* translators: %1$s: The argument name. %2$s: The view name. */

[452] Fix | Delete

__( 'The %1$s argument must be a non-empty string for %2$s.' ),

[453] Fix | Delete

'<code>url</code>',

[454] Fix | Delete

'<code>' . esc_html( $view ) . '</code>'

[455] Fix | Delete

[456] Fix | Delete

'6.1.0'

[457] Fix | Delete

);

[458] Fix | Delete

[459] Fix | Delete

continue;

[460] Fix | Delete

}

[461] Fix | Delete

[462] Fix | Delete

if ( empty( $link['label'] ) || ! is_string( $link['label'] ) || '' === trim( $link['label'] ) ) {

[463] Fix | Delete

_doing_it_wrong(

[464] Fix | Delete

__METHOD__,

[465] Fix | Delete

sprintf(

[466] Fix | Delete

/* translators: %1$s: The argument name. %2$s: The view name. */

[467] Fix | Delete

__( 'The %1$s argument must be a non-empty string for %2$s.' ),

[468] Fix | Delete

'<code>label</code>',

[469] Fix | Delete

'<code>' . esc_html( $view ) . '</code>'

[470] Fix | Delete

[471] Fix | Delete

'6.1.0'

[472] Fix | Delete

);

[473] Fix | Delete

[474] Fix | Delete

continue;

[475] Fix | Delete

}

[476] Fix | Delete

[477] Fix | Delete

$views_links[ $view ] = sprintf(

[478] Fix | Delete

'<a href="%s"%s>%s</a>',

[479] Fix | Delete

esc_url( $link['url'] ),

[480] Fix | Delete

isset( $link['current'] ) && true === $link['current'] ? ' class="current" aria-current="page"' : '',

[481] Fix | Delete

$link['label']

[482] Fix | Delete

);

[483] Fix | Delete

}

[484] Fix | Delete

[485] Fix | Delete

return $views_links;

[486] Fix | Delete

}

[487] Fix | Delete

[488] Fix | Delete

/**

[489] Fix | Delete

* Gets the list of views available on this table.

[490] Fix | Delete

[491] Fix | Delete

* The format is an associative array:

[492] Fix | Delete

* - `'id' => 'link'`

[493] Fix | Delete

[494] Fix | Delete

* @since 3.1.0

[495] Fix | Delete

[496] Fix | Delete

* @return array

[497] Fix | Delete

[498] Fix | Delete

protected function get_views() {

[499] Fix | Delete

12 3 4