WordPressに絞り込み検索を実装できる Search & Filter Pro の使い方

先日Yahoo!リスティング広告でもページ内に絞り込み検索の実装が必須となりました。

絞り込み検索を実装してほしい、という依頼はよく頂くのですが、その際のプラグイン「Search & Filter」の有料版「Search & Filter Pro」(以下S&F)が素晴らしかったので記事を書きます。

検索対象にカスタムフィールドを使うので、今回は「 Advanced Custom Fields」(以下ACF)プラグインと併用した場合の方法を書きます。

「Advanced Custom Fields」の設定

カスタムフィールド(各記事に持たせる属性を指定できるフィールド)を作る

・フィールドラベル

記事投稿/編集画面の下の方に出てくる、設定項目のラベル名

・フィールド名

内部で持つ変数。S&FのMeta Keyに指定する値

・フィールドタイプ

  • チェックボックス(複数選択できる)
  • ラジオボタン(どれか1つのみ選択)
  • 真/偽(2択)
  • テキスト
  • 数値(価格など)

・選択肢

主にチェックボックスとラジオボタンのみ出現。「変数名(英数字) : ラベル名」という構成にする(コロンの左右には半角スペース)。この変数名S&Fの各検索項目の選択肢(Options)のValueに指定します(ただしフィールドタイプが「真/偽」の場合はValueは「真が1、偽が0」になります。これはS&Fの時に後述します)。

このコロンの左右半角スペースを入れ忘れると「red:赤」というバリューが選択肢として設定されてしまいます(記事編集画面の下のカスタムフィールド の選択肢も「red:赤」とそのままでる)。この状態で登録してしまうと後ほどS&Fで選択肢を作成するときAutomaticallyでは「red:赤」という選択肢が生成されてしまうことになり、それを直そうとACFを「red : 赤」とコロンの左右に半角スペースを入れて更新すると今度は違う選択肢と見なされ全ての投稿で設定のやり直しをするハメになります。

もう一度言います。選択肢のコロンの左右に半角スペースを忘れないでください。

・デフォルト値

選択肢が広い方(不明など)や、安全側(送料無料の真/偽ならチェック外す方をデフォルト)に設定することをお勧めします。

新規投稿を追加/投稿の編集画面での設定

ACFで設定したら「記事投稿画面」の下の方に設定項目がでてきます(もし出ていなければ、右上の「表示オプション」でチェックがついているか確認してみてください)。

参考になるサイト:http://kotori-blog.com/wordpress/advanced-custom-fields/

「Search & Filter Pro」の設定


無料版のS&Fと同様、作成したSearch Formの右に記載されているショートコードを(ビジュアルリッチエディタでなく)テキストエディタに貼り付ければ、そこに挿入されます。

もちろんウィジェットにも貼り付けられます(テキストウィジェットでもカスタムHTMLウィジェットでもOK)。

ただし無料版と違う点として、ショートコードの記述で検索フォームを作るのではなく、プラグインで作成したフォームにidが振られ、そのidを含むショートコードを貼り付けるだけでOKという点。

UI的にも分かりやすいですし、フォームの内容を編集すれば、ショートコードを貼り直さなくても自動反映されるので便利ですね!さすが有料版。

検索フォーム自体の設定(検索対象にする投稿タイプなど)

一般設定(General)

Search in the following post types:
どの投稿タイプを検索対象にするか。通常は「投稿」のみです。

・Auto submit form?:
何かを選択した時に「送信ボタン」を押さなくても自動で検索実行するか。選択肢を選んでいると勝手に実行しちゃうので、通常はチェックを外します。

・Maintain Search Form State:
検索フォームの状態を維持するか。サイドバーなど検索結果一覧ページにも検索フォームが表示されるときに、その指定した条件をキープするかを設定できるます。検索条件を少し変えて再度検索したいユーザーのために、チェックをつけることを推奨します。

・Enable Auto Count:

Dynamically update the count number shown and also calculate which options to hide in your tag, category, taxonomy & post meta (choice) fields.

例えば物件検索などでドロップダウンボックスやチェックボックスで条件を絞っていった時、もし該当件数をページ上に表示していれば、それをリアルタムで更新するようです(未確認)。ただデフォルトでは該当件数は出ないはずなので、ちょっと上級向けかもしれません。後から出てくるパーツの詳細設定の中で「Display count?:」(検索項目の各選択肢の末尾に該当する記事数を表示させる)と混同しないように(私はしていました)。

後半の「(タグ、カテゴリ、タクソノミー、投稿メタ情報の中で)どの選択肢を隠すべきか計算します」?に関してはよく分かりません。

・Detect defaults from current page:

When a Search Form is used on any page other than the Search Results Page, S&F will try to detect the post type and associated taxonomies of the current page – and set defaults in the Search Form to match these.

英訳がちょっと不安なのですが、例えばカテゴリ「美容」に属する投稿記事に検索を設置した時、その検索項目「カテゴリ」にデフォルトで「美容」にチェックをつけるかどうかを指定できます。チェックボックスがなくなって強制指定になった?ようです。

Choose which kinds of pages S&F will try to do this on:
「S&Fをどの種類のページで使うか選んでください」という英訳になると思います。基本は投稿記事(orカスタム投稿タイプの記事)を検索するはずで、Archivesというのはsearch.phpやindex.phpと同様に記事一覧を表示するページテンプレートであるarchive.phpのことだと思います。なので一番上の「Post Type Archives」にチェックを付けると思うのですが、ちょっと自信がありません。わかる人いたら教えて欲しく。



Display Results

「Template Options」にある「Enter the filename of the custom template」にはお使いのテーマで検索結果一覧に使われているページテンプレートを指定しないとエラーになります(上のUse a custom template for results?のチェックを外せば、指定ファイルが間違っていても大丈夫かも)。

デフォルトはsearch.phpになっており、多くのWordPressテーマもこのsearch.phpを採用しているようですが、index.phpを使っていたりhome.phpしかなかったり、独自でsearch-custom.phpというページテンプレートを使っていたりします。

Posts

「検索対象記事に非公開や下書きを含めるか」みたいな設定ができます。

その他の設定

その他の項目は、検索対象をタグやカテゴリー、投稿メタ情報(特にカスタムフィールド )で絞ったりするものなどですが、基本はデフォルトのままで大丈夫だと思います。

・Tags, Categories & Taxonomies
検索対象に含める/除外するカテゴリー、タグ、フォーマットを指定できます。3番目のフォーマット(post_format)は投稿タイプとは別な気がします(未確認)。

・PostMeta
検索対象を投稿メタ情報(主にカスタムフィールド )で絞り込む。次に出てくる絞る際のキーとしてのPost Metaをごっちゃになりそうなので、必要でない限り指定しない方が無難かと。

・Advanced
上級者向けの設定のようでよく分かりません。

フォームのパーツ設置

Available Fieldsから、ドラッグ&ドロップでSearch Form UIに各パーツを設置することで、検索フォームに項目(キーワード検索や価格帯項目、送信ボタンなど)を設置します。

  • Search:キーワードで検索
  • Category:カテゴリで検索
  • Tag:タグで検索
  • PostMeta:投稿メタ情報で検索(カスタムフィールドで設定した値で絞るのはコレ)
  • Submit Button:送信ボタン
  • Reset Button:検索条件をリセットするボタン

それぞれのパーツの詳細設定

今回主に使うPost Metaによる検索項目は3つのタブがあります。
・Number:数字で絞る(価格帯など)
・Choice:選択肢で絞る(今回は主にこれ)
・Date:日付で絞る

Input type:
・ドロップダウン(どれか一つ。選択肢が多い場合に使われる)
・チェックボックス(yes/noの二択、もしくは複数選択を許容させる場合)
・ラジオボタン(どれか一つ。選択肢が少ない場合に使われる)

Add a heading?:
検索項目のヘッダラベルを指定(卵殻膜や価格帯など)

Change All Items Label?:
「すべて」の選択肢のラベルには、標準で「All Items」という選択肢が自動追加されるが、そのラベルを(こだわらない、すべて、指定なし等に)変えられます。

Display count?:
選択肢に該当する記事数を()で表示します。。例えばドロップダウンボックスでカテゴリの検索をするようにしている場合「Apple関連の記事(12)」のように表示されます。チェック推奨。

Hide Emplty?:
1つも該当記事がない選択肢を隠します。

Meta Key:(重要)
ここでACFで設定した「フィールド名」を選択します。

Options:
オプション(任意)サービスではなく、ここでは選択肢の意味です。Get OptionsをAutomaticallyに設定し「is ACF Field?」にチェックを入れれば本来は選択肢を自動取得してくれますが、日本語のためか上手く動作しない場合もあるようです。その場合は手動(Manual Entry)で対応します(ACFで作成したカスタムフィールドがまだどの記事でも未設定の場合はAutomaticallyやManual EntryのBrowse Optionsが効かなかったりするようです)。

Order Options by:
選択肢の表示順を設定できます。画像の例だとValue(ACFで設定したyesやnoなどの値)をアルファベット順で、降順(DESC)にして表示されます。ラベル名(配合や無配合)で昇順(ASC)などにできます。ただ日本語だと上手く動かない場合があるかも知れません。

Value:(重要)
ここも重要でACFで各検索項目の選択肢に設定した変数を入力します。これが検索をかけるときのキーになります。ACFで「真/偽」を設定したときは(慣習的に真のときは1、偽のときは0となる仕様なので)「1」を設定します。

フォームデザインの変更

デザインはS&Fでは設定できない仕様のようです。外観>カスタマイズ>追加CSSなどに直接CSSを書いてカスタマイズするしかないようです。

あとがき

今回はAdvanced Custom Fieldsを使いましたが、私もよく使っていたCustom Field Templateプラグインでも同じことができると思います。

これ系のプラグインはよくKOTORIさんの記事を参考にするのですが、KOTORIさんも絶賛されていました。
http://kotori-blog.com/wordpress/advanced-custom-fields/

さらに、カスタムフィールドでなく、カスタムタクソノミー(カテゴリやタグみたいな投稿画面の右側に出てくる奴をカスタムでも増やせる)で検索をかけることもできます。

これをするにはCPT UI(Custom Post Type UIプラグイン)を使います。

ややこしいですが、これは本来「カスタム“投稿”タイプ(カスタムポストタイプ)」を追加・管理するためのプラグインですが、このプラグインで「カスタム“タクソノミー”」も追加できるので、組み合わせると便利だよって話です。

・カスタム投稿タイプ(デフォルトでは投稿と固定ページのみ。LPというタイプが追加されているテーマも多い)

・カスタムフィールド(投稿にオリジナルの属性を紐づけられる。記事編集画面の下の方にでてきます。All in One SEOプラグインでtitleやdescritionを入力する欄も同じ場所にでますが、これもカスタムフィールドが生成されていると思われる)

・カスタムタクソノミー(カテゴリやタグなど。複数の属性を持たせる時はこっちの方がよさそう)

この辺がごちゃごちゃになりやすいので、混乱なきよう。

Shareこの記事をシェアしよう!

Commentsこの記事についたコメント

8件のコメント
  • 中原

    はじめまして、いつもブログ参考にさせて頂き、とてもお世話になっております

    https://blog.right-apps.com/develop/2018/search-filter-pro/
    今回こちらの記事を参考に、自身のブログへ
    絞り込み機能を搭載しようとチャレンジしてみているのですが
    流れの通り進めていくと、Search & Filter PROの
    パーツ詳細設定⇒Post MetaのMeta Key部分に、Advanced Custom Fieldsで設定したフィールド名がドロップダウン表示されません。

    お手数ではありますが、どうか助言頂けないでしょうか。どうぞ宜しくお願い致します。

    2019-01-15 20:39
    • takuya108817

      コメントありがとうございます。フィールド名は英数字で他と被りない形ですよね?一応聴くとハイフンとかアンダーバーって入ってますか?

      もしかすると
      >検索フォーム自体の設定(検索対象にする投稿タイプなど)
      の方のMeta KeyやAdvancedで何かチェックを入れる必要があったような気もします…。もしそうだったらすみません…

      メタキーが選択肢ででるところのスクショとか貼ってもらえるとより有り難いです(>_<)

      2019-01-15 21:07
  • TOMO

    はじめまして、search & filter pro解説を探していたので非常に参考になりました。

    現在こちらの記事を参考にsearch & filter proの設定をしているのですが、
    カスタムフィールドからフィールドタイプ⇒ラジオボタンにし、
    選択肢に2つの選択肢を設けました。

    反映された実際の画面でラジオボタンのいずれかにチェックを入れると絞り込まれるのですが、
    その後に別のボタンに再度チェックを入れるとURL自体は変更されるのですが画面が変更しない(新たなチェック先のページに遷移しない)という現象が起きてます。
    誠に恐れ入りますがもしよろしければご助言いただけますと幸いです。何卒よろしくお願いいたします。

    2019-06-14 16:02
    • takuya108817

      TOMOさん、はじめまして。
      ①これは Auto submit form? を有効にしてる形ですよね?
      ②Manual Entryですか?
      ③Valueは英語ですよね?

      同じ現象は起きたことないのですが、考えられそうなこととしては
      ・上記①~③でないと不具合が起きることがある
      ・そうでなければキャッシュ(S&F自体が生成するもの)が悪さしている

      後者については検索結果に対象記事が出てくれないなど結構あるある不具合で、そういう時は僕は一から作り直してます(複製しちゃだめ)。

      日本語ゆえに安定しない部分があるようです。うーむ。

      2019-06-15 11:03
  • もも

    はじめまして。こちらの記事を参考にsearch&filter Proの絞込検索の実装をしております。
    チェックリスト等は表示されるのですが、検索ボタンを押すとエラーがでます。value値を間違えたかと思っていましたが、どうやら違うようです。
    URLを貼っておきますので、原因と解決策があれば教えていただきたいです。よろしくお願いいたします。
    https://inuhon.com/%E6%A4%9C%E7%B4%A2/

    2019-06-14 21:55
    • takuya108817

      ももさん、こんにちは。今見たらエラー文の確認できなかったのですが、もう解決した形ですかね(PCのChromeで確認。フロント側も Developer Tool の Consoleも)?

      もしそうれあれば知見の共有のために簡単に原因教えていただけると皆が助かります!

      2019-06-15 11:08
  • TOMO

    まつたくさん

    お世話になっております。
    先日コメントで相談させていただきましたTOMOです

    こんなに早くお返事をいただけると思っていなかったもので
    確認が遅れて申し訳ございません。

    コメントありがとうございました!
    この後修正・対応しまして原因が判明し次第
    改めてフィードバックさせていただきます!

    まずはとりいそぎ御礼までに。

    2019-06-18 14:29
    • takuya108817

      おお!原因わかったのですね!それは何よりです!
      解決策合わせてご自身のブログなり、Qiitaの記事のURLを共有していただけるだけで全然ありがたいです〜!楽しみにしてます!

      2019-06-18 17:29

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です