jQueryを利用してWordPressでオートコンプリート(検索サジェスト機能)を実装する方法

  • 24779
    views
  • このエントリーをはてなブックマークに追加
  • follow us in feedly

利用する機会があるか?どうか??は別として、jQuery を利用してWordPress でオートコンプリート(検索サジェスト機能)を実装する方法のまとめです。

Google サジェストのような高機能なモノは実現できませんので…。あらかじめこちらで用意した単語を検索キーワード候補として表示させてあげるという、ホントちょっとした機能になります。

今回は、シンプルなオートコンプリート機能でUIもカスタマイズしやすい jQuery UI Touch Punch のプラグインを利用して、自由に設定した文字列に加えて、WordPress のカテゴリの中からキーワード候補を出力してみようと思います。

jQuery UI Touch Punch のダウンロード

まずは以下のページより jQuery UI Touch Punch プラグインファイルをダウンロードします。


jQuery ファイルの設置

ダウンロードした jquery.ui.touch-punch.min.js と jquery ファイル、jquery-ui.js ファイルをまとめて以下のように設置します。
<link rel="stylesheet" href="http://code.jquery.com/ui/1.10.0/themes/base/jquery-ui.css" />
<script src="./jquery.min.js"></script>
<script src="./jquery-ui.js"></script>
<script src="./jquery.ui.touch-punch.min.js"></script>
※javascript ファイルの設定場所はお使いの環境に合わせて補正してください。
※jquery.min.js は1.7.1、jquery-ui.js は1.8.21 のバージョンで動いています。全部試していませんが、バージョンによっては正常に動作しない場合があります。
※あと、4行目のjquery-ui.css は必須ファイルではありません。



検索キーワード候補として「自由に設定した文字列」を表示させる

まず最初に、自由に設定した文字列を検索キーワード候補として表示させた上で、どういう動きをするか??を確認してみます。

プラグインファイル配布先のサイト で掲載されている以下のコードを(1)で設定したjavascript ファイルの下に追記します。
<script>
$(function() {
    var availableTags = [
	"wordpress プラグイン",
	"wordpress",
	"WordPress"
    ];
    $( "#tags" ).autocomplete({
      source: availableTags
    });
  });
</script>

続いてテーマファイル内に設置されている検索フォームで、<input type=”text”>の部分に id=”tags”を記述します。
<form method="get" id="" action="<?php bloginfo('url'); ?>/">
<input type="text" id="tags" name="s">
<input type="submit" value="検索">
</form>
これで、例えば「w」と検索フォームに文字を打ち込んだ段階で「wordpress プラグイン」「wordpress」「WordPress」の3つのキーワード候補が表示されるようになります。

jquery-ui.css そのままを利用しているので、サイトやブログに合わせて追ってデザインを微調整しようと思います。
jQueryを利用してWordPressでオートコンプリート(検索サジェスト機能)を実装する方法

検索キーワード候補に「カテゴリ一覧」を追加する

WordPress で設定されているカテゴリ一覧をキーワード候補に追加してあげるには(2)のコードを以下のように改変します。
<script>
$(function() {
    var availableTags = [
	<?php
	$cat_all = get_terms( "category", "fields=all&get=all" );
	foreach($cat_all as $value):
	?>
	"<?php echo $value->name;?>",
	<?php endforeach; ?>
	"wordpress プラグイン",
	"wordpress",
	"WordPress"
    ];
    $( "#tags" ).autocomplete({
      source: availableTags
    });
  });
</script>
4〜9 行目で何をしているかと言うと、get_terms() でカテゴリを取得して、get=all で全てのカテゴリを表示させています。後はお好みで、order、orderby でソートさせても良いかもしれません。

と、こんな感じで検索キーワード候補が増えました。
※当ブログのカテゴリがショボいので、ほとんど変化が見られませんが…。
jQueryを利用してWordPressでオートコンプリート(検索サジェスト機能)を実装する方法

デザインを補正する

以下のように .ui-autocomplete に対して独自のスタイルを記述してあげれば(1)で読み込ませた jquery-ui.css のCSS ファイルは必要有りません。
<script src="./jquery.min.js"></script>
<script src="./jquery-ui.js"></script>
<script src="./jquery.ui.touch-punch.min.js"></script>

<style>
.ui-autocomplete {
width:200px;	
position:relative;
background:#fff;
box-shadow: 0 0 0 #fff, 0 0 0 #ccc, 0 0 1px #222;
-webkit-box-shadow: 0 0 0 #fff, 0 0 0 #ccc, 0 0 1px #222;
-moz-box-shadow: 0 0 0 #fff, 0 0 0 #ccc, 0 0 1px #222;
z-index:1000!important;
text-align:left;
max-height:500px;
overflow-y: auto;
overflow-x: hidden;
}
.ui-autocomplete li 		{background:none;border:none;padding:5px;}
.ui-autocomplete li a		{text-decoration:none;}
.ui-autocomplete li:hover 	{cursor:pointer;background:#f9f9f9!important;border:none;padding:5px;}
</style>
こんな感じで表示されます。
jQueryを利用してWordPressでオートコンプリート(検索サジェスト機能)を実装する方法

CSS をゴニョゴニョ触れば、見せ方はもっと変えられると思います。

IE8 以下では試していませんが、IE9、Firefox、Google Chome のブラウザであれば動いています。

  • 24779
    views
  • このエントリーをはてなブックマークに追加
  • follow us in feedly

この投稿と関連する記事一覧

この記事に関するコメント

  1. […] Shared jQueryを利用して、WordPressでオートコンプリート(検索サジェスト機能)を実装する方法 | IMAGINATION DESIGN BLOG – WordPress Mac.の情報を中心に紹介. […]

コメントを残す

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください