user_search_columns filter-hook . WP 3.6.0
Filters the columns to search in a WP_User_Query search.
The default columns depend on the search term, and include 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename', and 'display_name'.
Usage
add_filter( 'user_search_columns', 'filter_function_name_5711', 10, 3 );
function filter_function_name_5711( $search_columns, $search, $this ){
// filter...
return $search_columns;
}
- $search_columns(string[])
- Array of column names to be searched.
- $search(string)
- Text being searched.
- $this(WP_User_Query)
- The current WP_User_Query instance.
Changelog
| Since 3.6.0 | Introduced. |
Where the hook is called
wp-includes/class-wp-user-query.php 549
$search_columns = apply_filters( 'user_search_columns', $search_columns, $search, $this );