WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Site_Query::get_search_sql()

WP_Site_Query::get_search_sql( string $search, string[] $columns ): string

In this article

Back to top

Used internally to generate an SQL string for searching across multiple columns.

Parameters

$searchstringrequired
Search string.
$columnsstring[]required
Array of columns to search.

Return

string Search SQL.

Source

protected function get_search_sql( $search, $columns ) {
	global $wpdb;

	if ( str_contains( $search, '*' ) ) {
		$like = '%' . implode( '%', array_map( array( $wpdb, 'esc_like' ), explode( '*', $search ) ) ) . '%';
	} else {
		$like = '%' . $wpdb->esc_like( $search ) . '%';
	}

	$searches = array();
	foreach ( $columns as $column ) {
		$searches[] = $wpdb->prepare( "$column LIKE %s", $like );
	}

	return '(' . implode( ' OR ', $searches ) . ')';
}

View all references View on Trac View on GitHub

UsesDescription
wpdb::esc_like()wp-includes/class-wpdb.php

First half of escaping for LIKE special characters % and _ before preparing for SQL.

wpdb::prepare()wp-includes/class-wpdb.php

Prepares a SQL query for safe execution.

Used byDescription
WP_Site_Query::get_site_ids()wp-includes/class-wp-site-query.php

Used internally to get a list of site IDs matching the query vars.

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.