wordpressの検索機能は適宜に応じて出力を変えることで絶妙なユーザービリティを発揮することが出来ます。
今回は、「キーワード検索なしのドロップダウン選択式」で、カスタムタクソノミーを絞り込んでみます。
htmlのformについての基礎
ひとまずHTMLのform要素で、wordpressの検索を実装する上で理解しておきたい基礎的な仕組みを簡易的にメモしていきます。
form method=””
フォームに入力された情報の送信方法。
getとpostがありますが、値を省略すると「get」になります。
それぞれの使い分けは以下の様な感じ。
get
データを「取り出す。」
検索に対して、ヒットしたコンテンツを「取り出し」たりするときに使います。
URLに付加して処理システムに渡されるので、長いデータを送るのには適しません。
Googleとかで検索した後にURLをみると、記号やら何やら色々と付け足されて、とても長くなっていることがわかります。
せいぜい数kbが上限でしょう
たとえば、textarea に入力されたデータを送る場合はpostが望ましいです。
post
フォームに入力された情報をデータベースに登録したり、書き換えたりする際にはこちらを使います。
form action=””
フォームに入力された情報を送信するURLを入力します。
HTML5では指定しなくてもよくなりました。
指定しない場合は、開いているページで処理します。
name=””
フォームでは複数の項目を同時に送信します。
それらを判別するのがこの「name」です。プログラムに送信されます。
value=””
フォームの初期値、テキストを指定できます。
何も入力していないのにすでに「http://」とか「お名前」が入っているとたいてい「value」のしわざでした。
最近では「placeholder」を指定するか、スクリプトで同様の装いをさせることが多いです。
select～ option～ /select
ドロップダウン式のリスト項目を出力します。
optionの「value値」が、selectの「name値」と紐付けられてクエリとして送信されます。
optionに「selected」と書くことで、初期選択項目を指定できます。
あとあまり知られていない気がしますが、selectに「size=””」を書き、値を1以上にするとリスト表示になります。
selectに「multiple」と書くと複数項目の選択が可能になります。
wordpressのフォームのしくみ
URL末尾に「?s=」を付け、その先に検索クエリを続けて、前項の「get」で渡して検索しています。
この「s」に格納しないことには何も出来ないのです。
ちなみにform acriton=””にはサイトのURLを指定します。
1 | <form action="<?php echo site_url('/'); ?>"> |
キーワードで検索する場合は、
1 | <input type="text" name="s" value="<?php echo $_GET['s']; ?>" /> |
と書くことで、出たテキストボックスに入れたキーワードがそのまま「s」によって渡され、検索されることになります。
ここまで説明したことはすべてテンプレートタグ1行で実装できます。
1 | <?php get_search_form(); ?> |
関数リファレンス/get search form – WordPress Codex 日本語版
出力HTML
2 | <form method="get" id="searchform" action="http://localhost/w/"> |
3 | <label class="hidden" for="s"> |
5 | <input value="" name="s" id="s" type="text"> |
6 | <button value="Search"><span class="icon-search"></span></button> |
カスタムタクソノミーやカテゴリーだけで絞り込み検索する方法（ドロップダウン）
テキストボックス無しで、ドロップダウン選択のみの検索を実装してみます。
1 | <div id="searchbox" class="searchbox"> |
2 | <form role="search" method="get" id="searchform" action="<?php echo home_url( '/' ); ?>"> |
3 | <label for="input-id">種別</label> |
4 | <input type="hidden" name="s"> |
5 | <input type="hidden" name="post_type" value="以下のタクソノミを含むカスタム投稿名" /> |
6 | <select id="input-id" name="カスタムタクソノミ名（ターム名）"> |
7 | <option value="" selected="true">指定なし</option> |
9 | $terms = get_terms('カスタムタクソノミ名' , 'get=all'); |
11 | foreach($terms as $term){ |
12 | echo '<option value="' . $term->slug . '">' . |
13 | esc_html($term -> name) . |
19 | <input type="submit" id="searchsubmit" value="検索" /> |
複数のタクソノミから絞り込みたい場合は、selectを増やしていけばいいだけです。
今回のキモですが、キーワード検索を行わないため、テンプレートタグでも直接input type=”text”の「s」に格納して渡していた検索クエリが渡せません。
そこで、
1 | <input type="hidden" name="s"> |
として、自由な入力項目でなく「ユーザーに表示されない項目として絶対に渡す」形をとります。
これで、selectから項目を選んだ状態で検索ボタンをクリックすることで、無事検索クエリがURLにパラメータとして渡されます！
そして今回、wordpressのテンプレートタグはget_termsのみですね。かんたん！
なにをやっているか
get_terms()
1 | mixed get_term( mixed $term , string $taxonomy [ , string $output = OBJECT [ , string $filter = 'raw' ] ] ) |
- $termにタームID（カスタムタクソノミID）もしくはカテゴリー情報、タグ情報のオブジェクトを指定
- $taxonomyは、$termで指定したタームを含んでいるカスタム投稿タイプ名を指定
- $outputは出力型を指定
- $filterは取得するデータのフィルター
を記述します。
今回はカスタムタクソノミ名を指定するのみです。
返り値のオブジェクトから、「$term->slug」をoptionのvalue値に指定し
「$term->name」を表示名に使用しています。
foreachでループさせているため、あとから管理画面でタクソノミの分類が追加されても自動で選択項目に追加されることになります。
ドロップダウンを実装するwordpressテンプレートタグ
1 | <?php wp_dropdown_categories( $args ); ?> |
4 | 'show_option_all' => すべての項目を選択できるようにするか, |
5 | 'show_option_none' => 選択しない という選択肢を表示するか, |
6 | 'orderby' => 並びの基準。（'ID'）, |
7 | 'order' => 並び順。デフォルトは（'ASC'）, |
8 | 'show_count' => 記事数を表示するか。（0）, |
9 | 'hide_empty' => 記事のない項目を表示するか（1）, |
10 | 'child_of' => 指定したカテゴリIDの子カテゴリを全て取得する（0】, |
11 | 'exclude' => 非表示のカテゴリをIDで指定, |
12 | 'echo' => HTMLで表示するか取得するか（1）, |
13 | 'selected' => カテゴリIDでを指定して、「selected」をつける（0）, |
14 | 'hierarchical' => 子カテゴリを階層化して表示するか（0）, |
15 | 'name' => selectの「name＝””」（'cat'）, |
17 | 'class' => class指定（'postform'】, |
18 | 'depth' => どの階層まで出力するか（0）, |
19 | 'tab_index' => tabindexの値（0）, |
20 | 'taxonomy' => 指定したタクソノミを出力する（'category'）, |
21 | 'hide_if_empty' => 該当カテゴリに項目がないときフォーム自体を出さない（false）, |
とても便利なのですが、今回はこれでは上手く行きませんでした。
以上、カテゴリ、タクソノミーでドロップダウン式検索を実装する方法でした。
メリットとしては、予め検索の選択肢を明示することでユーザーを迷わせにくい点があります。
サイト全体の検索というよりは、下層ページで細分化しているコラム記事とかで実装するとよさそうですね。
コピペで行けますので、ぜひ！
機会があったらチェックボックスなどを使ってガッツリとした検索も実装してみたいです。
でわ！
