Changeset 53280

Timestamp:

04/26/2022 02:02:14 PM (4 years ago)

Author:

SergeyBiryukov

Message:

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.

Location:

trunk/src/wp-includes

Files:

• class-wp-comment-query.php (modified) (3 diffs)
• class-wp-term-query.php (modified) (1 diff)
• class-wp-user-query.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-comment-query.php

@@ -1127 +1127 @@
 
         /**
-         * 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
@@ -1133 +1133 @@
          * @global wpdb $wpdb WordPress database abstraction object.
          *
-         * @param string $search
-         * @param array  $cols
-         * @return string
-         */
-        protected function get_search_sql( $search, $cols ) {
+         * @param string   $search  Search string.
+         * @param string[] $columns Array of columns to search.
+         * @return string Search SQL.
+         */
+        protected function get_search_sql( $search, $columns ) {
                 global $wpdb;
 
@@ -1143 +1143 @@
 
                 $searches = array();
-                foreach ( $cols as $col ) {
-                        $searches[] = $wpdb->prepare( "$col LIKE %s", $like );
+                foreach ( $columns as $column ) {
+                        $searches[] = $wpdb->prepare( "$column LIKE %s", $like );
                 }
 

trunk/src/wp-includes/class-wp-term-query.php

@@ -1069 +1069 @@
          * @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 ) {

trunk/src/wp-includes/class-wp-user-query.php

@@ -869 +869 @@
          * @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;
 
@@ -883 +883 @@
                 $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 );
                         }
                 }