[ Index ]

WordPress Cross Reference

title

Body

[close]

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

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

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

Defines 1 class

WP_List_Table:: (35 methods):
  __construct()
  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_column_info()
  get_column_count()
  print_column_headers()
  display()
  get_table_classes()
  display_tablenav()
  extra_tablenav()
  display_rows_or_placeholder()
  display_rows()
  single_row()
  single_row_columns()
  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

param: array $args An associative array with information about the current table

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 $args An associative array with information about the pagination

get_pagination_arg( $key )   X-Ref
Access the pagination args

param: string $key
return: array

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
Display the search box.

param: string $text The search button text
param: string $input_id The search input id

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()   X-Ref
Display the bulk actions dropdown.


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

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

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

param: array $actions The list of actions
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


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


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

param: int $post_id
param: int $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

return: int

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


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_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
Display the table


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

return: array

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


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


display_rows_or_placeholder()   X-Ref
Generate the <tbody> part of the 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

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

param: object $item The current item

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: Tue Mar 25 01:41:18 2014 WordPress honlapkészítés: online1.hu