フック
SearchWPのSupplemental Engineにより、検索結果はフックに限定されます。
SearchWPには、プラグインコード自体を損なうことなく独自のカスタマイズを可能にするための、数多くのフックが含まれています。フックを使用してSearchWPと統合すると、SearchWPのバージョンアップ時にも変更をそのまま維持することができます。
WordPressのフックを初めて使用する場合は、このSearchWPカスタマイズプラグイン作成ガイドに従ってください。
クエリ
-
searchwp\query - このフックを使用して、検索クエリ自体を直接操作できます。
-
searchwp\query\args - すべての検索クエリを実行するために使用される \SearchWP\Query の引数をカスタマイズします。
-
searchwp\query\before - モジュールがセットアップされる前に、\SearchWP\Query クエリが実行される直前に発生します。
-
searchwp\query\do_source_db_where - SearchWP がソースの db_where() 条件を考慮するかどうかを制御します。この機能は、SearchWP のインデクサーがキャプチャできなかった方法でコンテンツの編集が行われた場合に保護層を追加します。使用しているソースによってキャプチャされた API を介してコンテンツの編集がすべて行われていると確信している場合 […]
-
searchwp\query\logic\{$type}\strict - 検索を実行する際のさまざまなロジックパスを通じて SearchWP がどのように機能するかを影響します。デフォルトでは、SearchWP は次の順序で検索を実行する際に一連のロジックパスを反復処理します: フレーズ（つまり「引用符付き」、文検索）と（つまりすべての検索用語がすべての結果に含まれる）または（つまり任意の検索用語がいずれかの結果に含まれる）各パスの後、 […]
-
searchwp\query\logic\and - AND ロジックが実行されるかどうかを制御します。注意: デフォルトでは、トークンしきい値を超えた場合、AND ロジックはスキップされます。デフォルトのしきい値は 5 ですが、searchwp\query\logic\and\token_threshold フックでカスタマイズできます。
-
searchwp\query\logic\and\token_threshold - SearchWP が AND ロジックパスを実行するかどうかを決定する際に考慮するしきい値を制御します。AND ロジックはリソースの観点から問題が発生する可能性があり、場合によってはクエリ時間が長くなる可能性があります。SearchWP の関連性アルゴリズムにより、検索用語が多すぎるために AND ロジックをスキップしても、最も […] のように結果の品質は低下しません。
-
searchwp\query\logic\phrase - SearchWP が引用符付きフレーズをサポートするかどうかを制御します。
-
searchwp\query\mods - 検索中に適用される \SearchWP\Mods をカスタマイズします。注意: クエリには内部の \SearchWP\Mods が存在する場合があります。このフックでは、これらのミッションクリティカルな \SearchWP\Mods をフィルタリングすることはできません。ユーザー定義の \SearchWP\Mods のみ可能です。内部については、searchwp\query\do_source_db_where も参照してください。
-
searchwp\query\output_suggested_search - SearchWP が検索の修正を自動的に提案するかどうかを制御します。
-
searchwp\query\partial_matches - 必要に応じて SearchWP が部分一致ロジックを適用するかどうかを制御します。
-
searchwp\query\partial_matches\buoy - 部分一致ロジックを実行する際に、完全一致に余分な関連性重みを与えるかどうかを制御します。
-
searchwp\query\partial_matches\did_you_mean - SearchWP が部分一致ロジックを適用する検索に対して、「〜でしたか？」スタイルの修正を実行するかどうかを制御します。
-
searchwp\query\partial_matches\force - 結果が見つかった場合でも、SearchWP に部分一致ロジックを実行するように強制します。
-
searchwp\query\partial_matches\fuzzy - 部分一致ロジックがファジーマッチングを使用するかどうかを制御します。デフォルト（有効な場合）では、SearchWP は 2 つのレベルの部分一致ロジックを利用します。検索文字列を含む部分一致を見つける 部分一致が見つからない場合は、検索用語に似た音のトークンを見つけようとします。
-
searchwp\query\partial_matches\fuzzy\force - デフォルトでは（部分一致が有効な場合）、SearchWPは2段階の部分一致ロジックを適用します。まず直接的な部分一致が適用され、部分一致が見つからない場合は、別のレベルのあいまい一致ロジックが適用されます。このフックは、部分一致が見つかった場合でも、あいまい一致を強制的に適用するために使用できます […]
-
searchwp\query\partial_matches\fuzzy\minimum_length - あいまい一致の最小長を制御します。
-
searchwp\query\partial_matches\fuzzy\threshold - あいまい一致と見なされるかどうかのしきい値を制御します。
-
searchwp\query\partial_matches\minimum_length - 部分一致の最小長を制御します。
-
searchwp\query\partial_matches\tokens - 部分一致ロジック適用中に部分一致トークンを操作します。
-
searchwp\query\partial_matches\wildcard_after - 部分一致ロジックを実行する際に、検索クエリの後にワイルドカードを追加するかどうかを制御します。
-
searchwp\query\partial_matches\wildcard_before - 部分一致ロジックを実行する際に、検索クエリの前にワイルドカードを追加するかどうかを制御します。
-
searchwp\query\per_page - 1ページあたりの結果数をカスタマイズします。
-
searchwp\query\result\load_data - 検索結果に対してSearchWPが該当するエントリー属性データを読み込むかどうかを制御します。注意：この機能が有効な場合、エンジンに追加された属性データのみが読み込まれます。searchwp\query\result\load_data\all_attributesも参照してください。
-
searchwp\query\result\load_data\all_attributes - 検索結果に対してSearchWPがすべてエントリー属性データを読み込むかどうかを制御します。注意：この機能が有効な場合、登録されているすべての属性データが読み込まれます。searchwp\query\result\load_dataも参照してください。
-
searchwp\query\results - SearchWPが見つけた結果を変更します。
-
searchwp\query\search_string - クエリの検索文字列をカスタマイズします。
-
searchwp\query\tokens\limit - 受け入れられる検索トークンの最大数を制御します。
-
searchwp\query\tokens\use_stems - クエリでトークンキーワードの語幹が使用されるかどうかを制御します。
投稿
-
searchwp\source\post\{$post_type}\attribution - 投稿タイプからの結果を、別の投稿IDにすべての重みを割り当てるように構成できるかどうかを制御します。
-
searchwp\source\post\{$post_type}\parent_attribution - 投稿タイプの検索結果が、親に重み付けを行うように設定できるかどうかを制御します。
-
searchwp\source\post\{$post_type}\parent_attribution\strict - 親の属性が有効になっている場合に、親を持たない投稿がどのように返されるかを制御します。
-
searchwp\source\post\attributes\comment - コメントをインデックスする前にカスタマイズします。
-
searchwp\source\post\attributes\comments\args - インデックス作成中に投稿からコメントを取得するために使用される引数を制御します。
-
searchwp\source\post\attributes\comments\author - WP_Postベースのソースにコメントが追加された場合、コメントの作成者をインデックスするかどうかを制御します。
-
searchwp\source\post\attributes\comments\email - WP_Postベースのソースにコメントが追加された場合、コメントのメールアドレスをインデックスするかどうかを制御します。
-
searchwp\source\post\attributes\content - 投稿コンテンツをインデックスする前にカスタマイズします。
-
searchwp\source\post\attributes\content\do_blocks - インデックス作成前に、ブロックエディタ（Gutenberg）ブロックをSearchWPが処理するかどうかを制御します。
-
searchwp\source\post\attributes\meta - カスタムフィールド（postmeta）データをインデックスする前に操作します。すべてのカスタムフィールドについては、searchwp\source\post\attributes\meta\${meta_key}も参照してください。
-
searchwp\source\post\attributes\meta\{$meta_key} - 単一のカスタムフィールドのカスタムフィールド（postmeta）データをインデックスする前に操作します。すべてのカスタムフィールドについては、searchwp\source\post\attributes\meta\${meta_key}も参照してください。
-
searchwp\source\post\attributes\meta\ignored - デフォルトでは、SearchWPは検索に適したコンテンツを含まないメタキーを無視します。このフックを使用して、無視するキーをカスタマイズできます。
-
searchwp\source\post\attributes\taxonomy\term - 投稿のタクソノミータームをインデックスする前に操作します。タクソノミーがエンジンに含まれている場合にのみ適用されます。すべてのタームを一度にフィルタリングするには、searchwp\source\post\attributes\taxonomy\termsも参照してください。
-
searchwp\source\post\attributes\taxonomy\terms - 投稿のタクソノミータームをインデックスする前に操作します。タクソノミーがエンジンに含まれている場合にのみ適用されます。個々のタームをフィルタリングするには、searchwp\source\post\attributes\taxonomy\termも参照してください。
-
searchwp\source\post\global_excerpt - 投稿コンテンツだけでなく、すべての投稿コンテンツから「グローバル」抜粋をSearchWPが見つけるかどうかを制御します。
-
searchwp\source\post\global_excerpt\{$post_type} - 単一の投稿タイプについて、投稿コンテンツだけでなく、すべての投稿コンテンツから「グローバル」抜粋をSearchWPが見つけるかどうかを制御します。
トークン
-
searchwp\tokens - インデックス作成時と検索時の両方でトークンを操作します。
-
searchwp\tokens\apply_rules_to_pattern_matches - 正規表現（regex）パターンマッチにSearchWPの検証ルール（例：最小長）を適用するかどうかを制御します。
-
searchwp\tokens\minimum_length - SearchWPがトークン（検索語）の最小長として何を使用するかを制御します。
-
searchwp\tokens\regex_patterns - SearchWPは、特定の文字列をそのまま保持し、検索時に有用性を低下させる可能性のあるトークン化を回避するために、正規表現パターンのマッチを検索します。デフォルトでは、SKU、日付、イニシャル、関数名、バージョン番号などの文字列を抽出するための一般的な正規表現パターンが多数用意されています。このフックを使用して、独自の […] を追加できます。
-
searchwp\tokens\regex_patterns\only_full_matches - デフォルトでは、SearchWPは正規表現パターンの完全一致のみを処理します。SearchWPに部分一致も考慮させたい場合は、このフックを使用してその動作を有効にすることができます。
-
searchwp\tokens\strict - SearchWPがトークンに対して厳密であるかどうかを制御します。無効になっている場合（デフォルトの動作）、SearchWPは文字のアクセントを削除します。
-
searchwp\tokens\tokenize_pattern_matches - 正規表現パターンマッチを個々の部分にトークン化するかどうかを制御します。
インデックス
-
searchwp\background_process\http_basic_auth_credentials - インデクサーにHTTP Basic認証の認証情報を教えます。注意：これらの認証情報はHTTP Basic認証用であり、WordPressのログイン認証情報ではありません。
-
searchwp\index\aggressive_delta - デフォルトでは、SearchWPはデルタ更新の処理にバックグラウンドプロセスを利用します。これにより、ページ読み込み時間を最小限に抑えることができます。代わりに、コンテンツ編集とインラインでデルタ更新を適用させたい場合は、このフックを使用できます。
-
searchwp\index\process\enabled - インデックスデルタ処理プロセスが有効かどうかを制御します。
-
searchwp\index\rebuild - インデックスがリセットされるたびに、再構築ジョブがトリガーされる直前にこのアクションが実行されます。
-
searchwp\index\tokens_max - デフォルトでは、SearchWPは最大500個のバッチでトークンを生成します。サーバーがそれ以上の処理能力があると感じる場合は、この制限を増やすことでインデックス作成プロセスのパフォーマンスが向上する可能性があります。このフックは、問題が発生した場合に、パッチごとに生成されるトークン数を減らすためにも使用できます […]
インデクサー
-
searchwp\background_process\http_basic_auth_credentials - インデクサーにHTTP Basic認証の認証情報を教えます。注意：これらの認証情報はHTTP Basic認証用であり、WordPressのログイン認証情報ではありません。
-
searchwp\indexer\alternate - SearchWPが代替インデクサーを使用するかどうかを制御します。SearchWPは代替インデクサーが必要な場合に自動的に検出しますが、このフックはその検出を上書きします。関連項目：代替インデクサー
-
searchwp\indexer\batch_size - インデクサーの各バッチ中にインデックスされるエントリの数を制御します。
-
searchwp\indexer\http_basic_auth_credentials - インデクサーにHTTP Basic認証の認証情報を教えます。注意：これらの認証情報はHTTP Basic認証用であり、WordPressのログイン認証情報ではありません。
統計
-
searchwp\admin\dashboard_widgets\statistics - SearchWPの統計機能の一部として、WordPress管理画面にログインした際に検索統計をすばやく確認できるダッシュボードウィジェットが提供されます。
-
searchwp\admin\dashboard_widgets\statistics\days - デフォルトでは、統計ダッシュボードウィジェットは過去30日間の人気のある検索を表示します。このフックを使用して、そのデフォルトを変更します。
-
searchwp\statistics\capability - SearchWPの統計を表示するために必要な権限を制御します。
-
searchwp\statistics\log - SearchWPがこの検索をログに記録するかどうかを制御します。
ストップワード
-
searchwp\stopwords - SearchWPは、インデックスの最適化と検索結果の関連性の向上の両方にストップワードを使用します。ストップワードリストをカスタマイズする主な方法は、SearchWP設定画面の設定タブを介して行います。ただし、プログラムでストップワードをフィルタリングすることもできます。
-
searchwp\stopwords\suggestions - SearchWPがストップワードを提案するかどうかを制御します。
-
searchwp\stopwords\suggestions\limit - SearchWPが表示するストップワードの提案数を制御します。
-
searchwp\stopwords\suggestions\threshold - 提案するストップワードを決定するために使用されるしきい値を制御します。
BackgroundProcess
-
searchwp\background_process\http_basic_auth_credentials - インデクサーにHTTP Basic認証の認証情報を教えます。注意：これらの認証情報はHTTP Basic認証用であり、WordPressのログイン認証情報ではありません。
-
searchwp\background_process\load_maximum - SearchWPがCPU負荷を監視している場合、最大負荷のしきい値をチェックします。このしきい値を超えると、SearchWPはCPU負荷をさらに増加させないようにインデックス作成プロセスをスケールバックします。サーバーに多くのコアがある場合、サーバーの能力に合わせてこの負荷最大値を増やすことができる可能性が高いです。
-
searchwp\background_process\load_monitoring - SearchWPは可能な限りシステムCPU負荷を監視し、サイト訪問者へのサービスの中断を回避するためにインデックス作成プロセスをスケールバックします。このフックを使用して、SearchWPの負荷監視を無効にすることができます。
-
searchwp\background_process\load_throttle - SearchWPの負荷監視がCPU負荷のしきい値を超えたことを検出すると、インデックス作成プロセスにタイムアウトが挿入されます。このフックを使用して、そのタイムアウトの期間をカスタマイズできます。
ドキュメント
-
searchwp\document\content - 抽出されたドキュメントコンテンツをカスタマイズします。
-
searchwp\document\pdf_metadata\skip - インデックス作成中にPDFメタデータをスキップするかどうか。
-
searchwp\document\skip - SearchWPがドキュメントの処理をスキップするかどうかを制御します。
パーサー
-
searchwp\parser\pdf - SearchWPのPDFパーサーの代わりに、外部のPDFパーサーを使用してPDFコンテンツを抽出します。
-
searchwp\parser\richtext - SearchWPのリッチテキストパーサーの代わりに、外部のリッチテキストパーサーを使用してリッチテキストコンテンツを抽出します。
-
searchwp\parser\text - SearchWPの代わりに、外部テキストパーサーを使用してテキストコンテンツを抽出します。
デバッグ
-
searchwp\debug - デバッグが有効かどうかを制御します。
-
searchwp\debug\dir - デバッグログの保存場所を変更します。
ソース
-
searchwp\source\attribute\options - ソースの属性オプションを変更します。
-
searchwp\source\check_db - SearchWPがソースのデータベースプロパティを検証するかどうかを制御します。
エントリ
-
searchwp\entry\data - インデックス作成される前に\SearchWP\Entryをカスタマイズします。
-
searchwp\entry\native - \SearchWP\Entryのネイティブオブジェクトをカスタマイズします。
ハイライター
-
searchwp\highlighter\case_insensitive - ハイライト時の大文字と小文字の区別を制御します。
-
searchwp\highlighter\partial_matches - ハイライトが部分一致を考慮するかどうかを制御します。
テンプレート
-
searchwp_live_search_results_entry_data - このフィルターフックを使用すると、SearchWP Live Searchの結果テンプレートにレンダリングされる前に、各SearchWP結果エントリのデータをカスタマイズできます。これは特にライブ検索の出力用であり、開発者がタイトル、パーマリンク、画像マークアップ、抜粋コンテンツなどの結果プロパティを変更できるようにします。
-
searchwp\results\entry\data - このフィルターフックを使用すると、SearchWPテンプレートに渡される前に、各SearchWP結果エントリの出力データをカスタマイズできます。表示されるタイトル、パーマリンク、画像、またはコンテンツを変更したり、投稿、タクソノミターム、またはユーザーなどの特定のオブジェクトタイプのマークアップを調整したりするために使用できます。
AdminBar
-
searchwp\admin_bar - SearchWPの管理バーエントリが有効かどうかを制御します。
同義語
-
searchwp\synonyms - SearchWPは、インデックスを最適化し、検索結果の関連性を高めるために同義語を使用します。同義語リストをカスタマイズする主な方法は、SearchWP設定画面の設定タブを経由することです。ただし、プログラムで同義語をフィルタリングすることもできます。
属性
-
searchwp\source\attribute\label - ソース属性ラベルをカスタマイズ
ライセンス
-
searchwp\license\key - ライセンスキーをプログラムで定義します。
ネイティブ
-
searchwp\native\short_circuit - SearchWPがWordPressのネイティブ検索をオーバーライドするかどうかを制御します。
設定
-
searchwp\settings\capability - SearchWPの設定を編集するために必要な権限を制御します。
SWP_Query
-
searchwp\swp_query\args - SWP_Queryをインスタンス化する際に使用される引数を変更します。
その他
-
searchwp\auto_update_providers - 注意：このフックは、マルチサイト環境でサイトを手動で切り替える場合にのみ適用されます。SearchWPはマルチサイト検索を実行できますが、switch_to_blog()を使用してサイトを手動で切り替える場合は、SearchWPにそれを通知する必要があります。これは自動的には発生せず、switch_to_blog()を使用する際のオプトイン要件です！このフックがない場合、SearchWP [...]
-
searchwp\extensions - SearchWPで使用される拡張機能を登録します。特にSearchWP設定UIの拡張機能メニューで使用されます。
-
searchwp\integration\wp-all-import - デフォルトでは、SearchWPは、コンテンツのインポート/移行との統合方法で説明されている方法に従って、WP All Importによって実行されるプロセスを自動的に処理します。このフックを使用して、独自のものを実装したい場合にSearchWPがWP All Importプロセスと自動的に統合するのを防ぐことができます。
-
searchwp\missing_integration_notices - デフォルトでは、SearchWPは、不足している統合拡張機能があるかどうかを確認します。このフックを使用してその動作を無効にすることができます。
-
searchwp\nuke_on_delete - アンインストール時にSearchWPがすべてのデータを削除するかどうか
-
searchwp\options\dashboard_stats_link - SearchWPの統計リンクが表示されるかどうかを制御します。
-
searchwp\options\settings_screen - SearchWPのオプションページが表示されるかどうかを制御します。
-
searchwp\post__in - インデックス作成および検索中に考慮される\WP_Post IDのグローバル制限を制御します。
-
searchwp\post__not_in - インデックス作成および検索中に考慮される\WP_Post IDのグローバル除外を制御します。
-
searchwp\post_stati - \WP_Postベースのソースで考慮される投稿ステータスを制御します。このフックが正しく有効になるためには、SearchWPのインデックスがどのように機能するかを理解する必要があります。インデックスは潜在的な結果の「最大」プールを表し、クエリはそのインデックスに対して実行されて返されるエントリを制限します。したがって、どの投稿を [...]
-
searchwp\sources - SearchWPによってインデックス作成および検索できるコンテンツを制御します。
-
searchwp\valid_html_tags - インデックス作成のためにコンテンツを抽出する際にSearchWPが考慮するHTMLタグを制御します。
-
searchwp\weights - SearchWP エンジンソース属性を設定する際に利用可能な重み間隔をカスタマイズします。
