users_list_table_query_args │ filter-hook │ WP 4.4.0

Filters the query arguments used to retrieve users for the Users list table in the admin area.

Usage

add_filter( 'users_list_table_query_args', 'wp_kama_users_list_table_query_args_filter' );

/**
 * Function for `users_list_table_query_args` filter-hook.
 * 
 * @param array $args Arguments passed to WP_User_Query to retrieve items for the current users list table.
 *
 * @return array
 */
function wp_kama_users_list_table_query_args_filter( $args ){

	// filter...
	return $args;
}

$args(array)

Arguments passed to WP_User_Query::prepare_query, which retrieves users for the current Users list table.

Examples

#1 Change the table sorting

add_action( 'users_list_table_query_args', function ( $args ) {
	// Sort by registration date
	$args['orderby'] = empty( $_REQUEST['orderby'] ) ? 'registered' : $_REQUEST['orderby'];
	// DESC - start the list with new users
	$args['order'] = empty( $_REQUEST['order'] ) ? 'DESC' : $_REQUEST['order'];

	return $args;
} );