Add filter to WP_Comments_List_Table::prepare_items get_comments arguments

[soulseekah]

Filtering the comments in the backend is quite hacky right now if not impossible.

This is a proposal to add a simple filter the $args parameter to the get_comments calls inside WP_Comments_List_Table::prepare_items.

[soulseekah]

Concept

[birgire]

Hi @soulseekah

This seems to be in line with other table query argument filters.

For example within the users list table:

 /**
  * Filters the query arguments used to retrieve users for the current users list table.
  *
  * @since 4.4.0
  *
  * @param array $args Arguments passed to WP_User_Query to retrieve items for the current
  *                    users list table.
  */
  $args = apply_filters( 'users_list_table_query_args', $args );

and within the sites list table:

/**
 * Filters the arguments for the site query in the sites list table.
 *
 * @since 4.6.0
 *
 * @param array $args An array of get_sites() arguments.
 */
$args = apply_filters( 'ms_sites_list_table_query_args', $args );

For the comments list table, I would suggest adjusting 42997.diff​ according to the same filter naming convention:

/**
 * Filters the arguments for the comment query in the comments list table.
 *
 * @since trunk
 *
 * @param array $args An array of get_comments() arguments.
 */
$args = apply_filters( 'comments_list_table_query_args', $args ); 

with similar adjustments to the docblock as for the sites list table.

[soulseekah]

Naming

[rachelbaker]

In 42420:

Comments: Introduce filter for the arguments for the comment query in the comments list table.

Add comments_list_table_query_args filter to the Comments List Table.

Props soulseekah, birgire.
Fixes #42997.

[johnbillion]

@since needs updating

[audrasjb]

@since refresh for 5.0.3

[audrasjb]

Hi,

@since is refreshed for 5.0.3.

[desrosj]

This falls outside of the scope for 5.0.3. Let's aim to add the new filter in 5.1.

[desrosj]

In 44530:

Docs: Update since annotation for comments_list_table_query_args.

Introduced in [42420].

Fixes #42997.