Add a filter in WP_Users_List_Table

[juliobox]

Hello

Can we (i) request a filter in the WP_Users_List_Table class, in the prepare_items() function :

Replace

// Query the user IDs for this page
$wp_user_search = new WP_User_Query( $args );

by

// Query the user IDs for this page
$args = apply_filters( 'users_list_table_args', $args );
$wp_user_search = new WP_User_Query( $args );

The goal is to hack the query of course.

Thank you

[jeremyfelt]

A similar filter would be useful in WP_MS_Users_List_Table as well. I opened #25285 to address any user query, but I'd be happy with a filter at the list table level as well.

[nofearinc]

Related: #26580

[juliobox]

Hello

Maybe a patch can help to close the ticket ;)

[SergeyBiryukov]

New filters should be documented per the ​documentation standards.

[roccotripaldi]

Tested and works well as a filter. The documentation should be addressed as @SergeyBiryukov mentions.

I'm wondering if the filter's should be different, for example, users_list_table_args and ms_users_list_table_args

Can you create future patches from the root?

[DrewAPicture]

In 34796:

Users: Introduce the users_list_table_query_args filter, for modifying the WP_User_Query arguments used within the prepare_items() methods in the users list tables.

The current list table is passed as a second parameter, $this, and can take the form of either a WP_Users_List_Table or WP_MS_Users_List_Table instance depending on the context in which the filter was evaluated.

Props juliobox for the initial patch.
Fixes #25360.

[DrewAPicture]

@jeremyfelt @roccotripaldi: In [34796], I passed the current list table instance as a second parameter, which should provide the necessary context to properly target the single vs multisite users list tables.

[jeremyfelt]

@DrewAPicture - I think we can remove the $this parameter. Both is_network_admin() and get_current_screen() can be used to determine context in a more straight forward way.

Also, blog_id is available in the original $args when MS where role is in the args when single site. That would be a little tougher to rely on, but is there.

[DrewAPicture]

In 34813:

Users: Don't pass the current WP_Users_List_Table or WP_MS_Users_List_Table instance to the users_list_table_query_args filter after all.

After some discussion, it was decided that Multisite vs single site context can just as easily be derived using available functions like is_network_admin(), get_current_screen(), etc., rendering the second parameter moot. The hook was introduced in [34796].

Fixes #25360.