Docs: Add missing documentation for WP_*_Query::get_search_sql() method parameters.

Includes renaming the `$cols` parameter to `$columns` for consistency across the classes.

Follow-up to [42876], [53272-53276].

See #54729.

git-svn-id: https://develop.svn.wordpress.org/trunk@53280 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2022-04-26 14:02:14 +00:00
parent ffc17842c7
commit 47c2d0ff83
3 changed files with 18 additions and 18 deletions

View File

@ -1126,24 +1126,24 @@ class WP_Comment_Query {
}
/**
* Used internally to generate an SQL string for searching across multiple columns
* Used internally to generate an SQL string for searching across multiple columns.
*
* @since 3.1.0
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $search
* @param array $cols
* @return string
* @param string $search Search string.
* @param string[] $columns Array of columns to search.
* @return string Search SQL.
*/
protected function get_search_sql( $search, $cols ) {
protected function get_search_sql( $search, $columns ) {
global $wpdb;
$like = '%' . $wpdb->esc_like( $search ) . '%';
$searches = array();
foreach ( $cols as $col ) {
$searches[] = $wpdb->prepare( "$col LIKE %s", $like );
foreach ( $columns as $column ) {
$searches[] = $wpdb->prepare( "$column LIKE %s", $like );
}
return ' AND (' . implode( ' OR ', $searches ) . ')';

View File

@ -1068,8 +1068,8 @@ class WP_Term_Query {
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $search
* @return string
* @param string $search Search string.
* @return string Search SQL.
*/
protected function get_search_sql( $search ) {
global $wpdb;

View File

@ -868,13 +868,13 @@ class WP_User_Query {
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $search
* @param array $cols
* @param bool $wild Whether to allow wildcard searches. Default is false for Network Admin, true for single site.
* Single site allows leading and trailing wildcards, Network Admin only trailing.
* @param string $search Search string.
* @param string[] $columns Array of columns to search.
* @param bool $wild Whether to allow wildcard searches. Default is false for Network Admin, true for single site.
* Single site allows leading and trailing wildcards, Network Admin only trailing.
* @return string
*/
protected function get_search_sql( $search, $cols, $wild = false ) {
protected function get_search_sql( $search, $columns, $wild = false ) {
global $wpdb;
$searches = array();
@ -882,11 +882,11 @@ class WP_User_Query {
$trailing_wild = ( 'trailing' === $wild || 'both' === $wild ) ? '%' : '';
$like = $leading_wild . $wpdb->esc_like( $search ) . $trailing_wild;
foreach ( $cols as $col ) {
if ( 'ID' === $col ) {
$searches[] = $wpdb->prepare( "$col = %s", $search );
foreach ( $columns as $column ) {
if ( 'ID' === $column ) {
$searches[] = $wpdb->prepare( "$column = %s", $search );
} else {
$searches[] = $wpdb->prepare( "$col LIKE %s", $like );
$searches[] = $wpdb->prepare( "$column LIKE %s", $like );
}
}