WP_List_Table

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 8

Every hook that fires from inside WP_List_Table, in the order it appears in the class, grouped by the method that fires it.

Properties · 10

$itemsarraypublic

The current list of items.

$_argsarrayprotected

Various information about the current table.

$_pagination_argsarrayprotected

Various information needed for displaying the pagination.

$screenWP_Screenprotected

The current screen.

$_actionsarrayprivate

Cached bulk actions.

$_paginationstringprivate

Cached pagination output.

$modesarrayprotected

The view switcher modes.

$_column_headersarrayprotected

Stores the value returned by ->get_column_info().

$compat_fieldsarrayprotected

$compat_methodsarrayprotected

Methods · 48

• __construct()Constructor.
• __get()Makes private properties readable for backward compatibility.
• __set()Makes private properties settable for backward compatibility.
• __isset()Makes private properties checkable for backward compatibility.
• __unset()Makes private properties un-settable for backward compatibility.
• __call()Makes private/protected methods readable for backward compatibility.
• ajax_user_can()Checks the current user's permissions
• prepare_items()Prepares the list of items for displaying.
• set_pagination_args()Sets all the necessary pagination arguments.
• get_pagination_arg()Access the pagination args.
• has_items()Determines whether the table has items to display or not
• no_items()Message to be displayed when there are no items
• search_box()Displays the search box.
• get_views_links()Generates views links.
• get_views()Gets the list of views available on this table.
• views()Displays the list of views available on this table.
• get_bulk_actions()Retrieves the list of bulk actions available for this table.
• bulk_actions()Displays the bulk actions dropdown.
• current_action()Gets the current action selected from the bulk actions dropdown.
• row_actions()Generates the required HTML for a list of row action links.
• months_dropdown()Displays a dropdown for filtering items in the list table by month.
• view_switcher()Displays a view switcher.
• comments_bubble()Displays a comment count bubble.
• get_pagenum()Gets the current page number.
• get_items_per_page()Gets the number of items to display on a single page.
• pagination()Displays the pagination.
• get_columns()Gets a list of columns.
• get_sortable_columns()Gets a list of sortable columns.
• get_default_primary_column_name()Gets the name of the default primary column.
• get_primary_column()Gets the name of the primary column.
• get_primary_column_name()Gets the name of the primary column.
• get_column_info()Gets a list of all, hidden, and sortable columns, with filter applied.
• get_column_count()Returns the number of visible columns.
• print_column_headers()Prints column headers, accounting for hidden and sortable columns.
• print_table_description()Print a table description with information about current sorting and order.
• display()Displays the table.
• get_table_classes()Gets a list of CSS classes for the WP_List_Table table tag.
• display_tablenav()Generates the table navigation above or below the table
• extra_tablenav()Displays extra controls between bulk actions and pagination.
• display_rows_or_placeholder()Generates the tbody element for the list table.
• display_rows()Generates the list table rows.
• single_row()Generates content for a single row of the table.
• column_default()
• column_cb()
• single_row_columns()Generates the columns for a single row of the table.
• handle_row_actions()Generates and display row actions links for the list table.
• ajax_response()Handles an incoming ajax request (called from admin-ajax.php)
• _js_vars()Sends required variables to JavaScript land.

Source code

View on Trac ↗View on GitHub ↗

15#[AllowDynamicProperties]16class WP_List_Table {17 18	/**19	 * The current list of items.20	 *21	 * @since 3.1.022	 * @var array23	 */24	public $items;25 26	/**27	 * Various information about the current table.28	 *29	 * @since 3.1.030	 * @var array31	 */32	protected $_args;33 34	/**35	 * Various information needed for displaying the pagination.36	 *37	 * @since 3.1.038	 * @var array39	 */40	protected $_pagination_args = array();41 42	/**43	 * The current screen.44	 *45	 * @since 3.1.046	 * @var WP_Screen47	 */48	protected $screen;49 50	/**51	 * Cached bulk actions.52	 *53	 * @since 3.1.054	 * @var array55	 */56	private $_actions;57 58	/**59	 * Cached pagination output.60	 *61	 * @since 3.1.062	 * @var string63	 */64	private $_pagination;65 66	/**67	 * The view switcher modes.68	 *69	 * @since 4.1.070	 * @var array71	 */72	protected $modes = array();73 74	/**75	 * Stores the value returned by ->get_column_info().76	 *77	 * @since 4.1.078	 * @var array79	 */80	protected $_column_headers;81 82	/**83	 * {@internal Missing Summary}84	 *85	 * @var array86	 */87	protected $compat_fields = array( '_args', '_pagination_args', 'screen', '_actions', '_pagination' );88 89	/**90	 * {@internal Missing Summary}91	 *92	 * @var array93	 */94	protected $compat_methods = array(

Changelog

Introduced in 3.1.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/class-wp-list-table.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.