| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
List Table API: WP_Posts_List_Table class
| File Size: | 2052 lines (61 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_Posts_List_Table:: (32 methods):
__construct()
set_hierarchical_display()
ajax_user_can()
prepare_items()
has_items()
no_items()
is_base_request()
get_edit_link()
get_views()
get_bulk_actions()
categories_dropdown()
formats_dropdown()
extra_tablenav()
current_action()
get_table_classes()
get_columns()
get_sortable_columns()
display_rows()
_display_rows()
_display_rows_hierarchical()
_page_rows()
column_cb()
_column_title()
column_title()
column_date()
column_comments()
column_author()
column_default()
single_row()
get_default_primary_column_name()
handle_row_actions()
inline_edit()
Class: WP_Posts_List_Table - X-Ref
Core class used to implement displaying posts in a list table.| __construct( $args = array() X-Ref |
| Constructor. param: array $args An associative array of arguments. since: 3.1.0 |
| set_hierarchical_display( $display ) X-Ref |
| Sets whether the table layout should be hierarchical or not. param: bool $display Whether the table layout should be hierarchical. since: 4.2.0 |
| ajax_user_can() X-Ref |
return: bool |
| prepare_items() X-Ref |
| has_items() X-Ref |
return: bool |
| no_items() X-Ref |
| No description |
| is_base_request() X-Ref |
| Determine if the current view is the "All" view. return: bool Whether the current view is the "All" view. since: 4.2.0 |
| get_edit_link( $args, $link_text, $css_class = '' ) X-Ref |
| Helper to create links to edit.php with params. return: string The formatted link string. param: string[] $args Associative array of URL parameters for the link. param: string $link_text Link text. param: string $css_class Optional. Class attribute. Default empty string. since: 4.4.0 |
| get_views() X-Ref |
return: array |
| get_bulk_actions() X-Ref |
return: array |
| categories_dropdown( $post_type ) X-Ref |
| Displays a categories drop-down for filtering on the Posts list table. param: string $post_type Post type slug. since: 4.6.0 |
| formats_dropdown( $post_type ) X-Ref |
| Displays a formats drop-down for filtering items. param: string $post_type Post type slug. since: 5.2.0 |
| extra_tablenav( $which ) X-Ref |
param: string $which |
| current_action() X-Ref |
return: string |
| get_table_classes() X-Ref |
return: array |
| get_columns() X-Ref |
return: array |
| get_sortable_columns() X-Ref |
return: array |
| display_rows( $posts = array() X-Ref |
param: array $posts param: int $level |
| _display_rows( $posts, $level = 0 ) X-Ref |
param: array $posts param: int $level |
| _display_rows_hierarchical( $pages, $pagenum = 1, $per_page = 20 ) X-Ref |
param: array $pages param: int $pagenum param: int $per_page |
| _page_rows( &$children_pages, &$count, $parent_page, $level, $pagenum, $per_page, &$to_display ) X-Ref |
| Given a top level page ID, display the nested hierarchy of sub-pages together with paging support param: array $children_pages param: int $count param: int $parent_page param: int $level param: int $pagenum param: int $per_page param: array $to_display List of pages to be displayed. Passed by reference. since: 3.1.0 (Standalone function exists since 2.6.0) since: 4.2.0 Added the `$to_display` parameter. |
| column_cb( $item ) X-Ref |
| Handles the checkbox column output. param: WP_Post $item The current WP_Post object. since: 4.3.0 since: 5.9.0 Renamed `$post` to `$item` to match parent class for PHP 8 named parameter support. |
| _column_title( $post, $classes, $data, $primary ) X-Ref |
param: WP_Post $post param: string $classes param: string $data param: string $primary since: 4.3.0 |
| column_title( $post ) X-Ref |
| Handles the title column output. param: WP_Post $post The current WP_Post object. since: 4.3.0 |
| column_date( $post ) X-Ref |
| Handles the post date column output. param: WP_Post $post The current WP_Post object. since: 4.3.0 |
| column_comments( $post ) X-Ref |
| Handles the comments column output. param: WP_Post $post The current WP_Post object. since: 4.3.0 |
| column_author( $post ) X-Ref |
| Handles the post author column output. param: WP_Post $post The current WP_Post object. since: 4.3.0 |
| column_default( $item, $column_name ) X-Ref |
| Handles the default column output. param: WP_Post $item The current WP_Post object. param: string $column_name The current column name. since: 4.3.0 since: 5.9.0 Renamed `$post` to `$item` to match parent class for PHP 8 named parameter support. |
| single_row( $post, $level = 0 ) X-Ref |
param: int|WP_Post $post param: int $level |
| 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, 'title'. since: 4.3.0 |
| handle_row_actions( $item, $column_name, $primary ) X-Ref |
| Generates and displays row action links. return: string Row actions output for posts, or an empty string param: WP_Post $item Post being acted upon. param: string $column_name Current column name. param: string $primary Primary column name. since: 4.3.0 since: 5.9.0 Renamed `$post` to `$item` to match parent class for PHP 8 named parameter support. |
| inline_edit() X-Ref |
| Outputs the hidden row displayed when inline editing since: 3.1.0 |
| Generated: Thu Nov 21 01:00:03 2024 | Cross-referenced by PHPXref 0.7.1 |