WordPressのキーワード検索で検索の対象や検索結果の内容を変更する
最終更新日: Update!!
一般的なWordPress案件ではあまり無いのですが、サービスサイトや商品情報がたくさんあるようなコーポレートサイトの制作では、キーワード検索のカスタマイズが必要になる要件が含まれていることもあります。今回はそんな時に使える、キーワード検索の対象や検索結果の内容を変更する方法についてまとめていきたいと思います。
ちなみに過去記事「キーワード検索でカスタマイズした検索機能を実装する」でもキーワード検索の実装に関する内容をまとめていますのでご参考に。
一般的にはメインクエリで投稿データを出力しますが、固定ページ内にカスタム投稿タイプの投稿を表示させた場合や、細かい条件を指定して投稿データを出力させたい場合にはサブクエリが使われます。このように2つの投稿記事の出力を使い分けることで、いろんな形で投稿データをサイト上に表示させることができます。
今回まとめている方法は、add_actionやadd_filterというフックを使うことで、クエリの内容を変更し、検索機能をカスタマイズしています。こうしてみると改めてWordPressの可能性に魅力を感じてしまいますね。工夫次第で自由度の高いシステムができるようになりますので色々と試してみたいですね。 (参考にさせて頂いたサイト) WordPressのサイト内検索でカスタムフィールドの内容も検索結果に含める方法
メインクエリ(メインループ)とサブクエリ(サブループ)
まず、WordPressの投稿記事の出力には、メインクエリ(メインループ)とサブクエリ(サブループ)という2つの違いを理解しておく必要があります。メインクエリ(メインループ) | URLのルーティングやWordPressの表示設定などに基づき、投稿データをループさせて出力します |
---|---|
サブクエリ(サブループ) | ルーティングやWordPressの設定とは異なる個別の条件を設定して、投稿データをループさせて出力します |
pre_get_postsでメインクエリを変更して検索結果を変更する
WordPressに用意されているフックの1つである「pre_get_posts」を使うことでメインクエリの出力結果を変更することができます。下記のコードでは検索結果を特定のカスタム投稿タイプに限定し、さらにソート順をランダムになるようメインクエリを変更しています。 【functions.php】<?php function custom_search_post_type($query) { if(is_admin() || !$query->is_main_query()) { return; } if($query->is_search()) { $query->set('post_type', 'POST_TYPE_SLUG'); $query->set('orderby', 'rand'); } } add_action('pre_get_posts','custom_search_post_type'); ?>add_actionというアクションフックで使う形になるのでfunctions.phpに記述します。注意しないといけないのは、pre_get_postsを使うと管理画面などにも影響が及ぶ点です。ですので、管理画面やサブクエリなどでは機能しないように条件分岐をかけておきます。 続けて、引数に対して適用する条件(上記では検索結果ページの場合)を設定し「$query->set()」で変更内容の指定を行います。複数にわたる場合には続けて書いていきます。このようにすることで、メインループを変更し、検索結果の内容をカスタマイズすることが可能になります。
カスタムフィールドの値もキーワード検索対象に加える
WordPressの機能でよく使われるものにカスタムフィールドがあります。このカスタムフィールドを使うことで自由度の高いコンテンツ管理が可能になります。デフォルトではカスタムフィールドの値は検索対象に含まれていないため、自前でカスタマイズする必要があります。 具体的な方法としては、クエリをadd_filterというフィルターフックを使い、そこでSQLを使って検索方法を変えていくという形になるようです。下記のコードをfunctions.phpに記述します。 【functions.php】<?php function custom_search( $search_result, $wp_query ) { global $wpdb; if( !$wp_query->is_search ) { return $search_result; } if( !isset( $wp_query->query_vars ) ) { return $search_result; } $keywords = explode(' ', isset( $wp_query->query_vars['s'] ) ? $wp_query->query_vars['s'] : ''); if ( count( $keywords ) > 0 ) { $search_result = ''; $search_result .= "AND post_type = 'material'"; foreach ( $keywords as $keyword ) { if ( !empty( $keyword ) ) { $keywords = '%' . esc_sql( $keyword ) . '%'; $search_result .= " AND ( {$wpdb->posts}.post_title LIKE '{$keywords}' OR {$wpdb->posts}.post_content LIKE '{$keywords}' OR {$wpdb->posts}.ID IN ( SELECT distinct post_id FROM {$wpdb->postmeta} WHERE meta_value LIKE '{$keywords}' ) ) "; } } } return $search_result; } add_filter( 'posts_search','custom_search', 10, 2 ); ?>最初に「$wpdb」という変数を設定しておくことで、WordPressのデータベースにアクセスできるようになります。そして上記の例では検索結果ページで実行される前提になるので、クエリとなるキーワードは半角スペースごとに1つの値として切り分け配列に格納されるようにしておきます。 続いて、キーワードごとにforeachで1つずつ検索をかけていくのですが、この時に引数に設定されている変数にSQLを設定します。その中で、WordPressのデータベースに含まれる各テーブルを参照していきます。細かい条件はこのSQLを変更することで対応できます。
今回まとめている方法は、add_actionやadd_filterというフックを使うことで、クエリの内容を変更し、検索機能をカスタマイズしています。こうしてみると改めてWordPressの可能性に魅力を感じてしまいますね。工夫次第で自由度の高いシステムができるようになりますので色々と試してみたいですね。 (参考にさせて頂いたサイト) WordPressのサイト内検索でカスタムフィールドの内容も検索結果に含める方法
sponserd
keyword search
categories
recent posts
- Shopifyでオリジナルテーマ制作やテーマカスタマイズで使えるTips #2
Shopifyでオリジナルテーマ制作やテーマカスタマイズで使えるTips #2
- Shopifyでオリジナルテーマ制作やテーマカスタマイズで使えるTips #1
Shopifyでオリジナルテーマ制作やテーマカスタマイズで使えるTips #1
- ViteでReactとReact Routerを使ってみる
ViteでReactとReact Routerを使ってみる
- ViteでPugのコンパイル環境を導入する
ViteでPugのコンパイル環境を導入する
- ViteでMarkuplintとPrettierを使える環境を構築する
ViteでMarkuplintとPrettierを使える環境を構築する
- ViteでStylelintとESlintを使える環境を構築する
ViteでStylelintとESlintを使える環境を構築する
- マウスオーバーしたセルを含む行列がハイライトするテーブルを作成する:has()擬似クラスの活用例
マウスオーバーしたセルを含む行列がハイライトするテーブルを作成する:has()擬似クラスの活用例
- ViteでVue.jsとVuex(Pinia)とVue Routerを使ってみる
ViteでVue.jsとVuex(Pinia)とVue Routerを使ってみる
comments
ヨシダジュン