PHPXRef 0.7.1 : WordPress Trunk (Updated Daily) : Detail view of class-wp-list-table.php

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

Constructor.

The child class should call this constructor from its own constructor to override
the default $args.

param: array|string $args {

__get( $name ) X-Ref

Makes private properties readable for backward compatibility.

param: string $name Property to get.
return: mixed Property.

__set( $name, $value ) X-Ref

Makes private properties settable for backward compatibility.

param: string $name Property to check if set.
param: mixed $value Property value.

__isset( $name ) X-Ref

Makes private properties checkable for backward compatibility.

param: string $name Property to check if set.
return: bool Whether the property is a back-compat property and it is set.

__unset( $name ) X-Ref

Makes private properties un-settable for backward compatibility.

param: string $name Property to unset.

__call( $name, $arguments ) X-Ref

Makes private/protected methods readable for backward compatibility.

param: string $name Method to call.
param: array $arguments Arguments to pass when calling.
return: mixed|bool Return value of the callback, false otherwise.

ajax_user_can() X-Ref

Checks the current user's permissions

prepare_items() X-Ref

Prepares the list of items for displaying.

set_pagination_args( $args ) X-Ref

Sets all the necessary pagination arguments.

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

get_pagination_arg( $key ) X-Ref

Access the pagination args.

param: string $key Pagination argument to retrieve. Common values include 'total_items',
return: int Number of items that correspond to the given pagination argument.

has_items() X-Ref

Determines whether the table has items to display or not

return: bool

no_items() X-Ref

Message to be displayed when there are no items

search_box( $text, $input_id ) X-Ref

Displays the search box.

param: string $text The 'submit' button label.
param: string $input_id ID attribute value for the search input field.

get_views_links( $link_data = array() X-Ref

Generates views links.

param: array $link_data {
return: string[] An array of link markup. Keys match the `$link_data` input array.

get_views() X-Ref

Gets the list of views available on this table.

The format is an associative array:
- `'id' => 'link'`

return: array

views() X-Ref

Displays the list of views available on this table.

get_bulk_actions() X-Ref

Retrieves the list of bulk actions available for this table.

The format is an associative array where each element represents either a top level option value and label, or
an array representing an optgroup and its options.

For a standard option, the array element key is the field value and the array element value is the field label.

For an optgroup, the array element key is the label and the array element value is an associative array of
options as above.

Example:

[
'edit'         => 'Edit',
'delete'       => 'Delete',
'Change State' => [
'feature' => 'Featured',
'sale'    => 'On Sale',
]
]

return: array

bulk_actions( $which = '' ) X-Ref

Displays the bulk actions dropdown.

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

current_action() X-Ref

Gets the current action selected from the bulk actions dropdown.

return: string|false The action name. False if no action was selected.

row_actions( $actions, $always_visible = false ) X-Ref

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

param: string[] $actions An array of action links.
param: bool $always_visible Whether the actions should be always visible.
return: string The HTML for the row actions.

months_dropdown( $post_type ) X-Ref

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

param: string $post_type The post type.

view_switcher( $current_mode ) X-Ref

Displays a view switcher.

param: string $current_mode

comments_bubble( $post_id, $pending_comments ) X-Ref

Displays a comment count bubble.

param: int $post_id The post ID.
param: int $pending_comments Number of pending comments.

get_pagenum() X-Ref

Gets the current page number.

return: int

get_items_per_page( $option, $default_value = 20 ) X-Ref

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

param: string $option User option name.
param: int $default_value Optional. The number of items to display. Default 20.
return: int

pagination( $which ) X-Ref

Displays the pagination.

param: string $which The location of the pagination: Either 'top' or 'bottom'.

get_columns() X-Ref

Gets a list of columns.

The format is:
- `'internal-name' => 'Title'`

return: array

get_sortable_columns() X-Ref

Gets a list of sortable columns.

The format is:
- `'internal-name' => 'orderby'`
- `'internal-name' => array( 'orderby', bool, 'abbr', 'orderby-text', 'initially-sorted-column-order' )` -
- `'internal-name' => array( 'orderby', 'asc' )` - The second element sets the initial sorting order.
- `'internal-name' => array( 'orderby', true )` - The second element makes the initial order descending.

In the second format, passing true as second parameter will make the initial
sorting order be descending. Following parameters add a short column name to
be used as 'abbr' attribute, a translatable string for the current sorting,
and the initial order for the initial sorted column, 'asc' or 'desc' (default: false).

return: array

get_default_primary_column_name() X-Ref

Gets the name of the default primary column.

return: string Name of the default primary column, in this case, an empty string.

get_primary_column() X-Ref

Gets the name of the primary column.

Public wrapper for WP_List_Table::get_default_primary_column_name().

return: string Name of the default primary column.

get_primary_column_name() X-Ref

Gets the name of the primary column.

return: string The name of the primary column.

get_column_info() X-Ref

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

return: array

get_column_count() X-Ref

Returns the number of visible columns.

return: int

print_column_headers( $with_id = true ) X-Ref

Prints column headers, accounting for hidden and sortable columns.

param: bool $with_id Whether to set the ID attribute or not

print_table_description() X-Ref

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

For the table initial view, information about initial orderby and order
should be provided via get_sortable_columns().

display() X-Ref

Displays the table.

get_table_classes() X-Ref

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

return: string[] Array of CSS classes for the table tag.

display_tablenav( $which ) X-Ref

Generates the table navigation above or below the table

param: string $which The location of the navigation: Either 'top' or 'bottom'.

extra_tablenav( $which ) X-Ref

Displays extra controls between bulk actions and pagination.

param: string $which

display_rows_or_placeholder() X-Ref

Generates the tbody element for the list table.

display_rows() X-Ref

Generates the list table rows.

single_row( $item ) X-Ref

Generates content for a single row of the table.

param: object|array $item The current item

column_default( $item, $column_name ) X-Ref

param: object|array $item
param: string $column_name

column_cb( $item ) X-Ref

param: object|array $item

single_row_columns( $item ) X-Ref

Generates the columns for a single row of the table.

param: object|array $item The current item.

handle_row_actions( $item, $column_name, $primary ) X-Ref

Generates and display row actions links for the list table.

param: object|array $item        The item being acted upon.
param: string       $column_name Current column name.
param: string       $primary     Primary column name.
return: string The row actions HTML, or an empty string

ajax_response() X-Ref

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

_js_vars() X-Ref

Sends required variables to JavaScript land.

File Size:	1877 lines (53 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of WordPress Trunk (Updated Daily)

/wp-admin/includes/ -> class-wp-list-table.php (summary)

Defines 1 class