Pocket

Frequently Searched Wordsリリース

久しぶりにWordPress公式プラグインを公開しました。
Frequently Searched Words

サイト内検索のウィジェットって思ったより使われていないので、検索ボックスの近くに「よく検索される単語」を準備してあげて検索の手間を減らしたいのと同時に、このサイトでよく検索される単語を表示することで、このサイトに何の情報があるのかを見せることもできるかなと考えたのでプラグイン化しました。

サイト内検索のトリガー

まず最初にサイト内検索で入力された単語を保存する方法を探りました。過去記事でWordPressのサイト内検索をカスタマイズという内容のものを書いた時におぼえたアクションフックpre_get_postsを使用して保存するロジックを書きました。
11行目のFrequently_Searched_Words_Admin_DbはDB関連の処理をまとめた独自クラスです。
13・14行目の処理は半角もしくは全角で区切った検索ワードを分割して一単語ずつ保存するようにしてあります。

search_post_updateという関数を作って、この関数をプラグインのコンストラクタで呼び出しています。

ショートコードで表示

保存した検索ワードをショートコードで表示します。検索ウィジェットの検索ボタンの下に表示させたいので、テーマのsearchform.php内に記述することにしました。

表示するとこんな感じです。ul要素に囲まれた状態でHTMLが出力されます。li要素で表示されたキーワードは、クリックするとサイト内検索と同じ動きをするようにリンクが貼ってあります。

ショートコード出力結果

これをCSSでいい感じにします。ショートコードの属性は以下の3つが設定できます。

  • id属性:ul要素にid属性が設定されます。
  • class属性:ul要素にclass属性が設定されます。
  • limit属性:出力するキーワードの最大表示数を設定できます。初期値は10です。

とりあえずclass属性を指定してCSSで調整します。

CSS側はこんな感じ。もともとウィジェットがul要素使っているので、強めのスコープで指定。

いい感じで表示できました。\(^o^)/

ショートコードをCSSで調整

本番反映と管理メニュー

ローカルで準備できたので、本番環境にアップロードします。(本番環境にもプラグインをインストールしておきます)
当然最初はサイト内検索が行われていないので何も表示されません。試しに検索してみます。(「Google Analytics」というキーワードで検索しました)

サイト内検索の結果表示

検索ボックスの下に「Google」と「Analytics」が表示されました。管理メニューの「Search Words」にも2つのキーワードが保存されていることが確認できます。これでOK!

管理メニュー「Search Words」

サイト内検索の計測はGoogle Analyticsでもできます。ビュー設定内に設定する箇所があるので、そこで設定します。こちらの計測の方が当然詳細にわかるでこちらもあわせて設定しておくと良いかなと思います。Google AnalyticsのAPIを使ってこのデータを取得というのも考えたのですが、検索させたいワードを意図的に出し分けしたい場合にちょっと辛いかなと思ったので、このプラグインを作ったというのもあります。

サイト内検索設定画面
Google Analyticsのサイト内検索設定

ソースコードはGitHubで公開中

プラグインのソースコードは、GitHubで管理しているので興味のある方はどうぞ。PRやForkなどしてくれると喜びます。今年はあと2〜3個プラグインをリリースしたいな。テーマもだけど。
Github:Frequently Searched Words

Frequently Searched Words