Filter hook 'user_search_columns'

in WP Core File wp-includes/class-wp-user-query.php at line 741

View Source

user_search_columns

Filter Hook
Description
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'.

Hook Information

File Location wp-includes/class-wp-user-query.php View on GitHub
Hook Type Filter
Line Number 741

Hook Parameters

Type Name Description
string[] $search_columns Array of column names to be searched.
string $search Text being searched.
WP_User_Query $query The current WP_User_Query instance.

Usage Examples

Basic Usage
<?php
// Hook into user_search_columns
add_filter('user_search_columns', 'my_custom_filter', 10, 3);

function my_custom_filter($search_columns, $search, $query) {
    // Your custom filtering logic here
    return $search_columns;
}

Source Code Context

wp-includes/class-wp-user-query.php:741 - How this hook is used in WordPress core
<?php
 736  			 *
 737  			 * @param string[]      $search_columns Array of column names to be searched.
 738  			 * @param string        $search         Text being searched.
 739  			 * @param WP_User_Query $query          The current WP_User_Query instance.
 740  			 */
 741  			$search_columns = apply_filters( 'user_search_columns', $search_columns, $search, $this );
 742  
 743  			$this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
 744  		}
 745  
 746  		if ( ! empty( $include ) ) {

PHP Documentation

<?php
/**
			 * 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'.
			 *
			 * @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.
			 */
Quick Info
  • Hook Type: Filter
  • Parameters: 3
  • File: wp-includes/class-wp-user-query.php
Related Hooks

Related hooks will be displayed here in future updates.