[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

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

Administration API: WP_List_Table class

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

Defines 1 class

WP_List_Table:: (46 methods):
  __construct()
  __get()
  __set()
  __isset()
  __unset()
  __call()
  ajax_user_can()
  prepare_items()
  set_pagination_args()
  get_pagination_arg()
  has_items()
  no_items()
  search_box()
  get_views()
  views()
  get_bulk_actions()
  bulk_actions()
  current_action()
  row_actions()
  months_dropdown()
  view_switcher()
  comments_bubble()
  get_pagenum()
  get_items_per_page()
  pagination()
  get_columns()
  get_sortable_columns()
  get_default_primary_column_name()
  get_primary_column()
  get_primary_column_name()
  get_column_info()
  get_column_count()
  print_column_headers()
  display()
  get_table_classes()
  display_tablenav()
  extra_tablenav()
  display_rows_or_placeholder()
  display_rows()
  single_row()
  column_default()
  column_cb()
  single_row_columns()
  handle_row_actions()
  ajax_response()
  _js_vars()


Class: WP_List_Table  - X-Ref

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

__construct( $args = array()   X-Ref
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
Make private properties readable for backward compatibility.

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

__set( $name, $value )   X-Ref
Make private properties settable for backward compatibility.

param: string $name  Property to check if set.
param: mixed  $value Property value.
return: mixed Newly-set property.

__isset( $name )   X-Ref
Make private properties checkable for backward compatibility.

param: string $name Property to check if set.
return: bool Whether the property is set.

__unset( $name )   X-Ref
Make private properties un-settable for backward compatibility.

param: string $name Property to unset.

__call( $name, $arguments )   X-Ref
Make 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
An internal method that 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
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()   X-Ref
Get an associative array ( id => link ) with the list
of views available on this table.

return: array

views()   X-Ref
Display the list of views available on this table.


get_bulk_actions()   X-Ref
Get an associative array ( option_name => option_title ) with the list
of bulk actions available on this table.

return: array

bulk_actions( $which = '' )   X-Ref
Display the bulk actions dropdown.

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

current_action()   X-Ref
Get the current action selected from the bulk actions dropdown.

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

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

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

months_dropdown( $post_type )   X-Ref
Display a monthly dropdown for filtering items

param: string $post_type

view_switcher( $current_mode )   X-Ref
Display a view switcher

param: string $current_mode

comments_bubble( $post_id, $pending_comments )   X-Ref
Display a comment count bubble

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

get_pagenum()   X-Ref
Get the current page number

return: int

get_items_per_page( $option, $default = 20 )   X-Ref
Get number of items to display on a single page

param: string $option
param: int    $default
return: int

pagination( $which )   X-Ref
Display the pagination.

param: string $which

get_columns()   X-Ref
Get a list of columns. The format is:
'internal-name' => 'Title'

return: array

get_sortable_columns()   X-Ref
Get a list of sortable columns. The format is:
'internal-name' => 'orderby'
or
'internal-name' => array( 'orderby', true )

The second format will make the initial sorting order be descending

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
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
Get a list of all, hidden and sortable columns, with filter applied

return: array

get_column_count()   X-Ref
Return number of visible columns

return: int

print_column_headers( $with_id = true )   X-Ref
Print column headers, accounting for hidden and sortable columns.

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

display()   X-Ref
Displays the table.


get_table_classes()   X-Ref
Get a list of CSS classes for the WP_List_Table table tag.

return: array List of CSS classes for the table tag.

display_tablenav( $which )   X-Ref
Generate the table navigation above or below the table

param: string $which

extra_tablenav( $which )   X-Ref
Extra controls to be displayed between bulk actions and pagination

param: string $which

display_rows_or_placeholder()   X-Ref
Generate the tbody element for the list table.


display_rows()   X-Ref
Generate the table rows


single_row( $item )   X-Ref
Generates content for a single row of the table

param: object $item The current item

column_default( $item, $column_name )   X-Ref

param: object $item
param: string $column_name

column_cb( $item )   X-Ref

param: object $item

single_row_columns( $item )   X-Ref
Generates the columns for a single row of the table

param: object $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 $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 if the current column is the primary column.

ajax_response()   X-Ref
Handle an incoming ajax request (called from admin-ajax.php)


_js_vars()   X-Ref
Send required variables to JavaScript land




Generated: Wed Oct 16 08:20:01 2019 Cross-referenced by PHPXref 0.7