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

Timestamp:

02/07/2023 08:53:01 AM (4 years ago)

Author:

audrasjb

Message:

Query: Add a search_columns argument to control which fields are searched in a search query.

Previously, the s argument of the WP_Query::parse_query() method searched the post_title, post_excerpt, and post_content fields, with no way of controlling this apart from using the posts_search filter and adjusting the SQL manually. This changeset adds the ability to specify which fields are searched when performing a query, using the search_columns argument.

Props johnbillion, birgire, petitphp, audrasjb, costdev, mukesh27.
Fixes #43867.

File:

• trunk/src/wp-includes/class-wp-query.php (modified) (5 diffs)

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

@@ -611 +611 @@
                         'author__in',
                         'author__not_in',
+                        'search_columns',
                 );
 
@@ -638 +639 @@
          * @since 5.3.0 Introduced the `$meta_type_key` parameter.
          * @since 6.1.0 Introduced the `$update_menu_item_cache` parameter.
+         * @since 6.2.0 Introduced the `$search_columns` parameter.
          *
          * @param string|array $query {
@@ -751 +753 @@
          *                                                    character used for exclusion can be modified using the
          *                                                    the 'wp_query_search_exclusion_prefix' filter.
+         *     @type array           $search_columns          Array of column names to be searched. Accepts 'post_title',
+         *                                                    'post_excerpt' and 'post_content'. Default empty array.
          *     @type int             $second                  Second of the minute. Default empty. Accepts numbers 0-59.
          *     @type bool            $sentence                Whether to search by phrase. Default false.
@@ -1411 +1415 @@
                 $q['search_orderby_title'] = array();
 
+                $default_search_columns = array( 'post_title', 'post_excerpt', 'post_content' );
+                $search_columns         = ! empty( $q['search_columns'] ) ? $q['search_columns'] : $default_search_columns;
+                if ( ! is_array( $search_columns ) ) {
+                        $search_columns = array( $search_columns );
+                }
+
+                /**
+                 * Filters the columns to search in a WP_Query search.
+                 *
+                 * The supported columns are `post_title`, `post_excerpt` and `post_content`.
+                 * They are all included by default.
+                 *
+                 * @since 6.2.0
+                 *
+                 * @param string[] $search_columns Array of column names to be searched.
+                 * @param string   $search         Text being searched.
+                 * @param WP_Query $query          The current WP_Query instance.
+                 */
+                $search_columns = (array) apply_filters( 'post_search_columns', $search_columns, $q['s'], $this );
+
+                // Use only supported search columns.
+                $search_columns = array_intersect( $search_columns, $default_search_columns );
+                if ( empty( $search_columns ) ) {
+                        $search_columns = $default_search_columns;
+                }
+
                 /**
                  * Filters the prefix that indicates that a search term should be excluded from results.
@@ -1440 +1470 @@
                         $like = $n . $wpdb->esc_like( $term ) . $n;
 
+                        $search_columns_parts = array();
+                        foreach ( $search_columns as $search_column ) {
+                                $search_columns_parts[ $search_column ] = $wpdb->prepare( "({$wpdb->posts}.$search_column $like_op %s)", $like );
+                        }
+
                         if ( ! empty( $this->allow_query_attachment_by_filename ) ) {
-                                $search .= $wpdb->prepare( "{$searchand}(({$wpdb->posts}.post_title $like_op %s) $andor_op ({$wpdb->posts}.post_excerpt $like_op %s) $andor_op ({$wpdb->posts}.post_content $like_op %s) $andor_op (sq1.meta_value $like_op %s))", $like, $like, $like, $like );
-                        } else {
-                                $search .= $wpdb->prepare( "{$searchand}(({$wpdb->posts}.post_title $like_op %s) $andor_op ({$wpdb->posts}.post_excerpt $like_op %s) $andor_op ({$wpdb->posts}.post_content $like_op %s))", $like, $like, $like );
-                        }
+                                $search_columns_parts['attachment'] = $wpdb->prepare( "(sq1.meta_value $like_op %s)", $like );
+                        }
+
+                        $search .= "$searchand(" . implode( " $andor_op ", $search_columns_parts ) . ')';
+
                         $searchand = ' AND ';
                 }