$table_name
$table_name : string
The table name
Action Scheduler Abstract List Table class
This abstract class enhances WP_List_Table making it ready to use.
By extending this class we can focus on describing how our table looks like, which columns needs to be shown, filter, ordered by and more and forget about the details.
This class supports:
$table_name : string
The table name
$package : string
Package name, used to get options from WP_List_Table::get_items_per_page.
$items_per_page : int
How many items do we render per page?
$search_by : array
Enables search in this table listing. If this array is empty it means the listing is not searchable.
$columns : array
Columns to show in the table listing. It is a key => value pair. The key must much the table column name and the value is the label, which is automatically translated.
$row_actions : array
Defines the row-actions. It expects an array where the key is the column name and the value is an array of actions.
The array of actions are key => value, where key is the method name (with the prefix rowaction<key>) and the value is the label and title.
$ID : string
The Primary key of our table
$sort_by : array
Enables sorting, it expects an array of columns (the column names are the values)
$filter_by : string
The default sort order
$status_counts : array
The status name => count combinations for this table's items. Used to display status filters.
$admin_notices : array
Notices to display when loading the table. Array of arrays of form array( 'class' => {updated|error}, 'message' => 'This is the notice text display.' ).
$table_header : string
Localised string displayed in the <h1> element above the able.
$bulk_actions : array
Enables bulk actions. It must be an array where the key is the action name and the value is the label (which is translated automatically). It is important to notice that it will check that the method exists (`bulk_$name`) and will throw an exception if it does not exists.
This class will automatically check if the current request has a bulk action, will do the
validations and afterwards will execute the bulk method, with two arguments. The first argument
is the array with primary keys, the second argument is a string with a list of the primary keys,
escaped and ready to use (with IN).
prepare_items() : mixed
Prepares the data to feed WP_Table_List.
This has the core for selecting, sorting and filtering data. To keep the code simple its logic is split among many methods (get_itemsquery*).
Beside populating the items this function will also count all the records that matches the filtering criteria and will do fill the pagination variables.
column_cb(array $row) : mixed
Renders the checkbox for each row, this is the first column and it is named ID regardless of how the primary key is named (to keep the code simpler). The bulk actions will do the proper name transformation though using `$this->ID`.
| array | $row | The row to render. |
get_bulk_actions() : array
Reads `$this->bulk_actions` and returns an array that WP_List_Table understands. It also validates that the bulk method handler exists. It throws an exception because this is a library meant for developers and missing a bulk method is a development-time error.
Throws RuntimeException when the bulk action does not have a callback method.
process_bulk_action() : mixed
Checks if the current request has a bulk action. If that is the case it will validate and will execute the bulk method handler. Regardless if the action is valid or not it will redirect to the previous page removing the current arguments that makes this request a bulk action.
get_items_query_order() : mixed
Prepares the ORDER BY sql statement. It uses `$this->sort_by` to know which columns are sortable. This requests validates the orderby $_GET parameter is a valid column and sortable. It will also use order (ASC|DESC) using DESC by default.
get_items_query_search() : string
Check if the current request is doing a "full text" search. If that is the case prepares the SQL to search texts using LIKE.
If the current request does not have any search or if this list table does not support that feature it will return an empty string.
maybe_render_actions(array $row, string $column_name) : string
Renders the row-actions.
This method renders the action menu, it reads the definition from the $row_actions property, and it checks that the row action method exists before rendering it.
| array | $row | Row to be rendered. |
| string | $column_name | Column name. |