site_search_columns

Filter Hook

Description

Filters the columns to search in a WP_Site_Query search. The default columns include 'domain' and 'path.

Hook Information

File Location	`wp-includes/class-wp-site-query.php` View on GitHub
Hook Type	Filter
Line Number	`627`

Hook Parameters

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

Usage Examples

Basic Usage

<?php
// Hook into site_search_columns
add_filter('site_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-site-query.php:627 - How this hook is used in WordPress core

<?php
 622  			 *
 623  			 * @param string[]      $search_columns Array of column names to be searched.
 624  			 * @param string        $search         Text being searched.
 625  			 * @param WP_Site_Query $query          The current WP_Site_Query instance.
 626  			 */
 627  			$search_columns = apply_filters( 'site_search_columns', $search_columns, $this->query_vars['search'], $this );
 628  
 629  			$this->sql_clauses['where']['search'] = $this->get_search_sql( $this->query_vars['search'], $search_columns );
 630  		}
 631  
 632  		$date_query = $this->query_vars['date_query'];

PHP Documentation

<?php
/**
			 * Filters the columns to search in a WP_Site_Query search.
			 *
			 * The default columns include 'domain' and 'path.
			 *
			 * @since 4.6.0
			 *
			 * @param string[]      $search_columns Array of column names to be searched.
			 * @param string        $search         Text being searched.
			 * @param WP_Site_Query $query          The current WP_Site_Query instance.
			 */

Quick Info

Hook Type: Filter
Parameters: 3
File: wp-includes/class-wp-site-query.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.