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.
Built from https://develop.svn.wordpress.org/trunk@53280


git-svn-id: http://core.svn.wordpress.org/trunk@52869 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2022-04-26 14:04:10 +00:00
parent 5ac4bf5ec6
commit 69be4c73ff
4 changed files with 19 additions and 19 deletions

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 );
}
}