apply_filters( 'user_search_columns', string[] $search_columns, string $search, WP_User_Query $query )
- Since
- 3.6.0
Filters the columns to search in a WP_User_Query search.
Description
The default columns depend on the search term, and include 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename', and 'display_name'.
Compatibility
- WordPress
- since 3.6.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$search_columnsstring[]- Array of column names to be searched.
$searchstring- Text being searched.
$queryWP_User_Query- The current WP_User_Query instance.
Where this hook fires · 1
wp-includes/class-wp-user-query.php:741WP_User_Query::prepare_query()
Source code
* @since 3.6.0 * * @param string[] $search_columns Array of column names to be searched. * @param string $search Text being searched. * @param WP_User_Query $query The current WP_User_Query instance. */ $search_columns = apply_filters( 'user_search_columns', $search_columns, $search, $this ); $this->query_where .= $this->get_search_sql( $search, $search_columns, $wild ); } if ( ! empty( $include ) ) { // Sanitized earlier.Changelog
Introduced in 3.6.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.