WPDev.one
Core Class

WP_List_Table

class WP_List_Table // Constructor: function Object() { [native code] }

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

Methods 48 methods

Method / Return Description
__construct()
void

Constructor.

Parameters: $args: mixed
__get()
mixed

Makes private properties readable for backward compatibility.

Parameters: $name: mixed
__set()
void

Makes private properties settable for backward compatibility.

Parameters: $name: mixed, $value: mixed
__isset()
bool

Makes private properties checkable for backward compatibility.

Parameters: $name: mixed
__unset()
void

Makes private properties un-settable for backward compatibility.

Parameters: $name: mixed
__call()
(mixed

Makes private/protected methods readable for backward compatibility.

Parameters: $name: mixed, $arguments: mixed
ajax_user_can()
void

Checks the current user's permissions

prepare_items()
void

Prepares the list of items for displaying.

set_pagination_args()
void

Sets all the necessary pagination arguments.

Parameters: $args: mixed
get_pagination_arg()
int

Access the pagination args.

Parameters: $key: mixed
has_items()
bool

Determines whether the table has items to display or not

no_items()
void

Message to be displayed when there are no items

search_box()
void

Displays the search box.

Parameters: $text: mixed, $input_id: mixed
get_views_links()
string[]

Generates views links.

Parameters: $link_data: mixed
get_views()
array

Gets the list of views available on this table.

views()
void

Displays the list of views available on this table.

get_bulk_actions()
array

Retrieves the list of bulk actions available for this table.

bulk_actions()
void

Displays the bulk actions dropdown.

Parameters: $which: mixed
current_action()
(string

Gets the current action selected from the bulk actions dropdown.

row_actions()
string

Generates the required HTML for a list of row action links.

Parameters: $actions: mixed, $always_visible: mixed
months_dropdown()
void

Displays a dropdown for filtering items in the list table by month.

Parameters: $post_type: mixed
view_switcher()
void

Displays a view switcher.

Parameters: $current_mode: mixed
comments_bubble()
void

Displays a comment count bubble.

Parameters: $post_id: mixed, $pending_comments: mixed
get_pagenum()
int

Gets the current page number.

get_items_per_page()
int

Gets the number of items to display on a single page.

Parameters: $option: mixed, $default_value: mixed
pagination()
void

Displays the pagination.

Parameters: $which: mixed
get_columns()
array

Gets a list of columns.

get_sortable_columns()
array

Gets a list of sortable columns.

get_default_primary_column_name()
string

Gets the name of the default primary column.

get_primary_column()
string

Gets the name of the primary column.

get_primary_column_name()
string

Gets the name of the primary column.

get_column_info()
array

Gets a list of all, hidden, and sortable columns, with filter applied.

get_column_count()
int

Returns the number of visible columns.

print_column_headers()
void

Prints column headers, accounting for hidden and sortable columns.

Parameters: $with_id: mixed
print_table_description()
void

Print a table description with information about current sorting and order.

display()
void

Displays the table.

get_table_classes()
string[]

Gets a list of CSS classes for the WP_List_Table table tag.

display_tablenav()
void

Generates the table navigation above or below the table

Parameters: $which: mixed
extra_tablenav()
void

Displays extra controls between bulk actions and pagination.

Parameters: $which: mixed
display_rows_or_placeholder()
void

Generates the tbody element for the list table.

display_rows()
void

Generates the list table rows.

single_row()
void

Generates content for a single row of the table.

Parameters: $item: mixed
column_default()
void

No description available.

Parameters: $item: mixed, $column_name: mixed
column_cb()
void

No description available.

Parameters: $item: mixed
single_row_columns()
void

Generates the columns for a single row of the table.

Parameters: $item: mixed
handle_row_actions()
string

Generates and display row actions links for the list table.

Parameters: $item: mixed, $column_name: mixed, $primary: mixed
ajax_response()
void

Handles an incoming ajax request (called from admin-ajax.php)

_js_vars()
void

Sends required variables to JavaScript land.

Properties

Property / Type Description
$items
mixed
public
No description available.
$_args
mixed
public
No description available.
$_pagination_args
mixed
public
No description available.
$screen
mixed
public
No description available.
$_actions
mixed
public
No description available.
$_pagination
mixed
public
No description available.
$modes
mixed
public
No description available.
$_column_headers
mixed
public
No description available.
$compat_fields
mixed
public
No description available.
$compat_methods
mixed
public
No description available.

Class Information

Since Version
3.1.0
Source File
wp-admin/includes/class-wp-list-table.php
Advertisement