[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

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

List Table API: WP_Comments_List_Table class

File Size: 1171 lines (35 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_Comments_List_Table:: (23 methods):
  __construct()
  floated_admin_avatar()
  ajax_user_can()
  prepare_items()
  get_per_page()
  no_items()
  get_views()
  get_bulk_actions()
  extra_tablenav()
  current_action()
  get_columns()
  comment_type_dropdown()
  get_sortable_columns()
  get_default_primary_column_name()
  display()
  single_row()
  handle_row_actions()
  column_cb()
  column_comment()
  column_author()
  column_date()
  column_response()
  column_default()


Class: WP_Comments_List_Table  - X-Ref

Core class used to implement displaying comments in a list table.

__construct( $args = array()   X-Ref
Constructor.

param: array $args An associative array of arguments.

floated_admin_avatar( $name, $comment_id )   X-Ref
Adds avatars to comment author names.

return: string Avatar with the user name.
param: string $name       Comment author name.
param: int    $comment_id Comment ID.

ajax_user_can()   X-Ref
Checks if the user can edit posts.

return: bool Whether the user can edit posts.

prepare_items()   X-Ref
Prepares the comments list items.


get_per_page( $comment_status = 'all' )   X-Ref
Gets the number of comments to display per page.

return: int Comments per page.
param: string $comment_status Comment status.

no_items()   X-Ref
Displays a message when no comments are found.


get_views()   X-Ref
Returns an array of comment status links.

return: array<string, string> Comment status HTML links keyed by view.

get_bulk_actions()   X-Ref
Gets the available bulk actions for the comments list.

return: array<string, string> Bulk action labels keyed by action name.

extra_tablenav( $which )   X-Ref
Displays extra controls between bulk actions and pagination.

param: string $which The location of the extra table nav markup: Either 'top' or 'bottom'.

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

return: string|false Current action or false if none.

get_columns()   X-Ref
Gets the list of columns.

return: string[] Array of column titles keyed by their column name.

comment_type_dropdown( $comment_type )   X-Ref
Displays a comment type drop-down for filtering on the Comments list table.

param: string $comment_type The current comment type slug.

get_sortable_columns()   X-Ref
Gets a list of sortable columns.

return: array<string, string|array> The sortable columns.

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, 'comment'.

display()   X-Ref
Displays the comments table.

Overrides the parent display() method to render extra comments.


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

param: WP_Comment $item The comment object.

handle_row_actions( $item, $column_name, $primary )   X-Ref
Generates and displays row actions links.

return: string Row actions output for comments. An empty string
param: WP_Comment $item        The comment object.
param: string     $column_name Current column name.
param: string     $primary     Primary column name.

column_cb( $item )   X-Ref
Outputs the checkbox column.

param: WP_Comment $item The comment object.

column_comment( $comment )   X-Ref
Outputs the comment column.

param: WP_Comment $comment The comment object.

column_author( $comment )   X-Ref
Outputs the author column.

param: WP_Comment $comment The comment object.

column_date( $comment )   X-Ref
Outputs the date column.

param: WP_Comment $comment The comment object.

column_response( $comment )   X-Ref
Outputs the response column.

param: WP_Comment $comment The comment object.

column_default( $item, $column_name )   X-Ref
Outputs the default column.

param: WP_Comment $item        The comment object.
param: string     $column_name The custom column's name.



Generated : Wed Apr 15 08:20:10 2026 Cross-referenced by PHPXref