SearchWP Documentation

インストールガイドを表示したり、ナレッジベースを参照したり、SearchWPの多くのフックについて確認したりできます。

関連

この拡張機能にはProライセンスが必要です

現在のバージョン: 1.5.5

SearchWPを使用して、サイト上の関連コンテンツを強化しましょう! 

SearchWP Related拡張機能は、最小限のオーバーヘッドで動作するように設計されており、サイトのデザインと機能要件に一致する広範なカスタマイズオプションを提供します。訪問者に関連記事を表示することは、エンゲージメントを維持し、ユーザーに追加のページを探索するように促す効果的な戦略です。現在別の関連記事システムを使用している場合、SearchWP Relatedは、SearchWPが既に作成したコンテンツインデックスを利用することで、サーバーのオーバーヘッドを削減する可能性があります。

注意: SearchWP Relatedアルゴリズムは、デフォルトのキーワードソースとして投稿エントリのタイトルを使用し、サイト全体で関連記事を特定して表示するため、訪問者に関連性があり文脈に合った提案を保証します。

セットアップと統合

すべてのSearchWP拡張機能と同様に、RelatedはSearchWPと並行して実行されるスタンドアロンのWordPressプラグインです。インストール後、Related拡張機能は、好みに応じて設定するまでデフォルトで非アクティブなままです。WordPressバックエンドエリアのSearchWP設定 → 関連に移動することで、すべての設定オプションにアクセスし、投稿ページに関連コンテンツが表示される方法をカスタマイズできます。

レイアウトテーマ

レイアウトテーマセクションでは、ウェブサイトのフロントエンドに関連コンテンツブロックを表示するための複数の事前デザインされたスタイルが提供されます。デザインがサイトの美学に合っていることを確認するために、さまざまなレイアウトテーマを簡単に切り替えて、各オプションをプレビューできます。

ミニマル: このテーマは、整理されたグリッド形式で配置された投稿タイトルのみを表示する、クリーンでシンプルなリストレイアウトを提示します。

カラム: このグリッドレイアウトは、投稿タイトルと説明の両方を特徴とする複数のカラムに結果を表示し、訪問者に各関連アイテムに関するより多くのコンテキストを提供します。

サムネイル: このレイアウトは、グリッド構造と大きなサイズのアイキャッチ画像を投稿タイトルと組み合わせて、視覚的なコンテンツを強調する視覚的に魅力的な表示を作成します。

リッチ: この包括的なレイアウトオプションは、視覚的なアピールと情報密度を最大化する魅力的なグリッド形式で、大きな画像、投稿タイトル、説明を特徴とする、最も視覚的に魅力的なプレゼンテーションを提供します。

カスタム: この柔軟なオプションにより、関連コンテンツ設定セクションのさまざまな設定を組み合わせて調整することで、特定のデザイン要件を満たす完全にカスタマイズされたレイアウトを作成できます。

レイアウトスタイル                                

レイアウトスタイル設定では、関連コンテンツを表示するためのグリッドビューとリストビューの形式を選択できます。さらに、各関連コンテンツブロック内に表示する関連結果の数を正確に指定できるため、訪問者に提示するコンテンツの量を精密に制御できます。

ブロックタイトル

ブロックタイトル設定は、フロントエンドの関連コンテンツセクションの上に表示される見出しテキストを決定します。デフォルト値は「関連コンテンツ」ですが、サイトのコンテンツに合わせて編集できます。

画像

各関連投稿に表示される画像のサイズを選択します。利用可能なサイズオプションは、小、中、大です。

説明
関連ブロックコンテンツの説明を表示または非表示にするトグル。

エンジン

エンジン設定は、関連コンテンツの提案に含まれる投稿タイプを決定するために使用されるSearchWPエンジンを定義します。選択したエンジン設定に追加された投稿ソースのみが、関連コンテンツブロックに表示される対象となります。

自動追加機能

自動追加機能を使用すると、手動で配置する必要なく、投稿ページに自動的に関連コンテンツブロックが表示される特定の投稿タイプを選択できます。SearchWPエンジンに追加された投稿タイプのみが、この設定で選択可能になります。

また、関連コンテンツをページに表示する正確な位置を指定することもできます。ブロックをコンテンツの下部または投稿コンテンツ内の特定の段落の後に表示するオプションがあります。

エントリを除外

エントリ除外オプションは、関連コンテンツの提案にどの投稿が表示されるかを細かく制御できます。サイト全体の関連コンテンツブロックに表示されないように、特定の投稿IDを除外できます。 

または、「選択したIDのみを検索」オプションを選択することで、関連コンテンツを定義済みの投稿リストに制限できます。

ブロックの埋め込み

自動追加オプション以外にも、関連コンテンツブロックをさまざまな方法で手動で埋め込むことができます。

Gutenbergブロック統合

Gutenbergブロックメソッドは、WordPressの最新のブロックエディターとのシームレスな統合を提供し、SearchWP関連コンテンツを任意の投稿またはページに直接埋め込むことができます。Gutenbergエディターで任意の投稿またはページを編集しながら、「関連」ブロックを検索し、目的の場所に簡単に追加します。

ショートコードの実装

[searchwp_related] ショートコードを使用して、ウェブサイトのショートコード互換領域にコンテンツを表示できます。 

ウィジェット統合

ウィジェット機能を持つサイドバー領域を利用するテーマの場合、SearchWP Relatedは専用のウィジェットオプションを提供し、投稿ページのサイドバー領域にコンテンツを表示できます。 

PHPコード統合

カスタム投稿テンプレートやテーマファイルを扱っている場合は、直接PHPコード統合を使用してコンテンツを実装できます。この方法は最も技術的な制御を提供し、開発者はカスタムテーマテンプレートコードとスタイリングフレームワーク内にコンテンツブロックを正確に配置できます。

投稿固有の設定

自動追加オプションで特定の投稿タイプを選択すると、それらの投稿タイプの投稿編集画面の「SearchWP Related Content」セクションの下に、追加のSearchWP Related拡張機能の設定が利用可能になります。

カスタムキーワード

デフォルトでは、関連コンテンツアルゴリズムは投稿タイトルに含まれるキーワードを分析して、各投稿の関連コンテンツの提案を特定します。ただし、カスタムキーワードオプションを使用すると、特定の投稿の関連コンテンツを見つけるための代替キーワードを指定できます。

この機能には、「結果サンプル」プレビューが含まれており、カスタムキーワードの選択に基づいて関連コンテンツブロックに表示される投稿が表示されるため、公開前に提案されたコンテンツの関連性を確認できます。

常に含める設定

カスタムキーワードセクションの右側にある設定ボタンをクリックすると、「常に含める」機能を含む追加の設定オプションが表示されます。

この強力なオプションを使用すると、アルゴリズムのマッチングに関係なく、現在の投稿の関連コンテンツブロックに表示することを保証したい特定の投稿タイトルを、手動で選択できます。これにより、重要なコンテンツや戦略的に関連性の高いコンテンツが関連コンテンツの提案に常に表示され、自動化された推奨事項に対する編集上の制御が可能になります。

出力のカスタマイズ:テンプレートローダー

Live Searchと同様に、Relatedもテンプレートローダーを使用して、Relatedの結果の**完全なカスタマイズ**を可能にします。デフォルトのテンプレートは次のようになります。

デフォルトのRelatedテンプレートは、テーマのフォントと色がある程度一致します

Relatedプラグインフォルダには、templatesという名前の別のフォルダがあり、Relatedコンテンツを表示するために使用されるこのデフォルトのRelatedテンプレート(related.php)が含まれています。

~/wp-content/plugins/searchwp-related/templates/related.php

このファイルのコンテンツは次のとおりです。related.php

このファイルを直接編集しないでください。Relatedのアップデートをインストールすると、このファイルに加えたカスタマイズは上書きされます!

代わりに、Relatedに組み込まれたテンプレートローダーを使用して、テーマ内に独自のカスタムテンプレートを追加できます。

Relatedコンテンツの出力をカスタマイズするには、テーマ内に新しいフォルダを作成し、デフォルトのRelatedテンプレートのコピーをそのフォルダに貼り付け、同じファイル名を維持します。

~/wp-content/themes/my-theme/searchwp-related/related.php

このテンプレートはニーズに合わせて完全にカスタマイズできます。これはThe Loopに基づいているため、テンプレート内でテーマの他のテンプレートと同様に任意の操作を実行できます。

テンプレートオプション

Relatedコンテンツを表示するために使用されるテンプレートはほとんど標準のテーマテンプレートですが、ファイルの先頭にあるオプションのコメントブロックを編集することで、Relatedの動作に影響を与えることができます。

/** * SearchWP Engine: default * Maximum Results: 3 */<code></code>

テンプレートの先頭にある該当する行を編集することで、使用するSearchWPエンジンと、表示される関連エントリの最大数をカスタマイズできます。

ファイル名にハイフンと投稿タイプを追加することで、投稿タイプごとに結果テンプレートをカスタマイズすることもできます。たとえば、このファイル名でテンプレートを作成した場合:

~/wp-content/themes/my-theme/searchwp-related/related-page.php

これは、ページにのみ使用されます。他のすべての投稿タイプは、基本テンプレートを使用します。

関連コンテンツをプログラムで取得する

テンプレートローダーを使用したいが、自動追加チェックボックスが使用する場所とは別の場所にしたい場合は、そのチェックボックスをオフのままにして、関連コンテンツを表示したい場所に次のコードを挿入するようにテンプレートファイルを編集してください。

<?php
// This should be within your single.php or other applicable template that has the $post defined
$related = new SearchWP_Related\Template();
echo $related->get_template();
view raw single.php hosted with ❤ by GitHub

テンプレートローダーを完全にスキップして、代わりにテーマコードで直接関連コンテンツを取得することもできます。その方法は次のとおりです。

<?php
/*
* Programmatically find Related content from SearchWP Related
*/
// Instantiate SearchWP Related
$searchwp_related = new SearchWP_Related();
// Use the keywords as defined in the SearchWP Related meta box
$keywords = get_post_meta( get_the_ID(), $searchwp_related->meta_key, true );
$args = array(
's' => $keywords, // The stored keywords to use
'engine' => 'default', // the SearchWP engine to use
'posts_per_page' => 3, // how many entries to find
);
// Retrieve Related content for the current post
$related_content = $searchwp_related->get( $args );
// Returns an array of Post objects for you to loop through
print_r( $related_content );
view raw functions.php hosted with ❤ by GitHub

関連コンテンツを見つける方法をカスタマイズするために渡すことができる引数はいくつかあります。以下に、可能な引数の完全な内訳を示します。

<?php
// Use the saved keywords from the meta box
$keywords = get_post_meta( get_the_ID(), $searchwp_related->meta_key, true );
$defaults = array(
'engine' => 'default', // Engine to use
's' => $keywords, // Terms to search
'fields' => 'all', // Return post objects, use 'ids' to return IDs
'posts_per_page' => 3, // How many results to return
'log' => false, // Log the search?
'post__in' => array(), // Limit results pool?
'post__not_in' => array() // Exclude posts from results?
);
view raw functions.php hosted with ❤ by GitHub

リソースの使用量を削減するために、何らかのキャッシュ(例:Transient経由)を設定することをお勧めします。

入力のカスタマイズ:関連コンテンツの定義

デフォルトでは、関連はエントリのタイトルからキーワードリストを構築します。関連結果の関連性を高めるために、一般的な単語は削除されます。各エントリ編集画面で、関連コンテンツを決定するために使用されるキーワードをカスタマイズできるメタボックスが関連によって出力されます。

キーワードをカスタマイズする際のリアルタイム結果サンプル

3つのサンプル結果のセットが表示され、必要に応じて使用するキーワードをカスタマイズできます。これは単なるサンプルであり、テンプレートローダーはフロントエンドでの結果の表示方法を制御し、SearchWPは実行時に表示するエントリを決定します。

結果サンプルには、利用可能なすべてのエンジンが含まれます。表示されるサンプルを一部のエンジンに限定したい場合は、このフィルターを使用できます。

<?php
// Define the engines to use for the metabox samples.
add_filter( 'searchwp_related_meta_box_sample_engines', function( $engines ) {
return [ 'default', 'products' ];
} );
view raw functions.php hosted with ❤ by GitHub

変更履歴

1.5.5

  • [更新] WP 6.9との互換性が更新されました。
  • [修正] ドロップダウン項目の余分な空行が削除されました。

1.5.4

  • [修正] 下書き、保留中の投稿が「常に含める」オプションにリストされ、フロントエンドに表示される可能性があります。
  • [更新] アップデーターを更新しました。

1.5.3

  • [新規] メタボックスサンプルに表示されるエンジンをフィルタリングするために、searchwp_related_meta_box_sample_enginesフックが追加されました。
  • [変更] サンプル結果がレスポンシブになりました。

1.5.2

  • [修正] SearchWPの「アナウンスを非表示」オプションが有効になっている場合のJavaScriptエラー。

1.5.1

  • [変更] 最新のWPバージョンとの互換性を示すために「テスト済み」タグが追加されました。
  • [変更] 一部のシステムで自動化がトリガーされるのを回避するために、ビルドファイルが削除されました。
  • [修正] SearchWPプラグインがアクティブでない場合のPHPエラー。

1.5.0

  • [新規] 設定エリアが刷新され、関連ブロックのコンテンツと視覚的な外観に対する制御が強化されました。
  • [新規] 手動埋め込みのために新しいGutenbergブロックとショートコードが追加されました。
  • [変更] 関連拡張機能に必要な最小 SearchWP バージョンは 4.2.6 です
  • [変更] 不要/未使用の関数とメソッドを削除しました

1.4.8

  • [修正] 関数呼び出しの末尾カンマによる、7.3より前のPHPバージョンでのエラー
  • [修正] メタボックスのキーワードフィールドの変更時にサジェストリストが再レンダリングされない問題
  • [修正] PHP 8.2での非推奨通知

1.4.7

  • [修正] PHP 7.2 以前の Parse error
  • [修正] SearchWP 4.2.0以降との互換性

1.4.6

  • [新規] searchwp_related_default_keywords にコンテキスト配列を追加しました
  • [修正] PHP Notice
  • [修正] 場合によってはプレビューで除外された投稿

1.4.5

  • [修正] 初期プレビューレンダリング

1.4.4

  • [修正] 場合によっては PHP Notice、Error
  • [更新] アップデーターを更新しました

1.4.3

  • [修正] 該当する場合、SearchWP Metrics へのログ記録を防止します

1.4.2

  • [修正] SearchWP 4 使用時のエラーを修正しました

1.4.0

  • [新規] SearchWP 4のサポートを追加

1.3

  • [新規] 各エントリに対して特定の関連エントリを強制します
  • [新規] 関連コンテンツは 12 時間キャッシュされるようになりました
  • [新規] クエリキャッシュの TTL を秒単位で制御するフック searchwp_related_cache_length
  • [新規] キャッシュの使用を制御するフック searchwp_related_cache_enabled
  • [修正] 場合によっては自動追加が機能しない問題
  • [修正] 場合によってはページネーションが尊重されない問題
  • [修正] 場合によってはデフォルトのキーワードが設定されない問題
  • [修正] ドキュメントへのリンク
  • [変更] デフォルトでは、メタボックスは公開されていない投稿タイプには表示されなくなりました
  • [変更] 初期結果セットが SearchWP によって過度に制限されている場合、追加の結果が見つかりました
  • [更新] 翻訳ソース
  • [更新] アップデーターを更新しました

1.1.1

  • [変更] フォールバックキーワードセットは、下書きが保存されるときに定義されるようになりました(以前は公開時に定義されていました)

1.1

  • [新規] ウィジェットを追加します
  • [新規] メタボックスの配置を制御する新しいフック searchwp_related_meta_box_context および searchwp_related_meta_box_priority

1.0.4

  • [修正] 過剰なエンキューの問題を修正しました

1.0.3

  • [修正] 特定の状況で関連エントリが見つからなかった問題を修正しました
  • [更新] アップデーターを更新しました

1.0.2

  • [修正] キーワードが入力されていない場合、新しく公開されたエントリは自動的にスキップされなくなりました。デフォルトでフォールバックが使用されます
  • [修正] searchwp_related_excluded_post_types フィルターの実装が正しく適用され、機能するようになりました

1.0.1

  • [修正] PHP(<5.5) の致命的なエラー Can't use function return value in write context を防止します

1.0.0

  • 初回リリース

今日からより良いWordPress検索エクスペリエンスを作成しましょう

役に立たない検索結果で訪問者を失うことはもうありません。SearchWPを使用すると、独自のスマートなWordPress検索をすばやく簡単に作成できます。

Get SearchWP Now
複数の検索エンジンアイコン