Changeset 53280 for trunk/src/wp-includes/class-wp-comment-query.php

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.

File:

• trunk/src/wp-includes/class-wp-comment-query.php (modified) (3 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 );
         }