概要
get_search_queryフィルタは、WordPressの検索クエリに関連したキーフレーズを操作するために使用されます。このフィルタは、検索機能のカスタマイズや、特定のトリガーに基づいて検索キーフレーズを変更する際に役立ちます。具体的には、以下のようなシナリオで使用されることがあります。
- 検索クエリを特定の条件に基づいて変更する際。
- ユーザーエクスペリエンスを向上させるため、クエリにスラングや代替表現を追加する際。
- 特定のユーザーやロールに応じて検索キーワードを調整する際。
- 検索内容に関連広告を表示する際に、似たキーワードを追加する際。
- 検索履歴を分析し、人気のあるキーワードを優先させる際。
- 文字列のフィルタリングによって、特定の不適切なキーワードを削除する際。
- SEOの観点から、検索キーワードの最適化を行う際。
- 特定のカスタムポストタイプに対して検索結果をカスタマイズする際。
構文
add_filter('get_search_query', 'custom_search_query_function');
パラメータ
string$search_query: 現在の検索クエリ文字列。
戻り値
string: 変更された検索クエリ文字列。
関連する関数
このフィルタを使用可能なバージョン
- すべてのWordPressバージョンで使用可能。
このフィルタが含まれるワードプレスのコアファイルのパス
wp-includes/query.php
サンプルコード
サンプル1: 検索キーフレーズを大文字にする
このコードは、検索キーフレーズを全て大文字に変換します。
add_filter('get_search_query', function($search_query) {
return strtoupper($search_query);
});
サンプル2: 特定の単語を追加する
このコードは、検索キーフレーズの末尾に「特別な」を追加します。
add_filter('get_search_query', function($search_query) {
return $search_query . ' 特別な';
});
サンプル3: 特定のキーワードをフィルタリング
このコードは、検索時に「禁止されたキーワード」を取り除きます。
add_filter('get_search_query', function($search_query) {
return str_replace('禁止されたキーワード', '', $search_query);
});
サンプル4: 検索クエリにストリングを追加
このコードは、検索キーフレーズの前に「レビュー」という語を追加します。
add_filter('get_search_query', function($search_query) {
return 'レビュー ' . $search_query;
});
サンプル5: カスタムポストタイプの検索
このコードは、特定のカスタムポストタイプの検索を強調するために、検索クエリを設定します。
add_filter('get_search_query', function($search_query) {
return $search_query . ' post_type:custom';
});
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
このフィルタは、特に特定のWordPressバージョンで非推奨または削除されることはありません。