このプラグインは2022年8月26日以降利用できなくなりました。個人的にはとても気に入っていて、無類のプラグインだっただけに、非常に残念です。
公式のサポートによれば、プラグインに発生している問題を解決して開発を続けることができないとのことですので、今後再利用できる可能性は低いと思われます。
メーカーサイトのマニュアルページや、ご存じGoogleのヘルプページの最後にある「この情報は役に立ちましたか?」というフィードバック(アンケート)フォーム。それらのサイトでなくても多分一度は見たことがあり、「はい」「いいえ」といった反応をしたこともあると思います。
こうした訪問者からのアクションに関して、WordPressで特にカスタマイズしていない状態であれば、標準機能であるコメント機能を使って受けることになりますが、「はい」「いいえ」という選択だけを行ってもらうというものではなく、メールアドレスの入力が必須だったりすることから、訪問者からすれば結構敷居が高いものではないかと思います。
今回紹介する【Helpful】は、「はい」「いいえ」式の回答を募りつつ、必要であればフィードバック(文章による回答)による意見の収集をすることもでき、結果を集計表示してダッシュボードやフロントエンドへ表示できる、特に技術系のサイトでは重宝するプラグインです。
【Helpful】プラグインの用途や機能
- その投稿(固定ページ)についての投票(「はい」「いいえ」の2択)を訪問者から得ることができます
- その投稿(固定ページ)についてフリーワードで意見を求めることができます(フィードバック機能)
- カスタム投稿タイプ含め、投稿タイプごとに本文下へフィードバックフォームを自動表示させるかどうかを選択できます
- 通常は表示しないようにしておき、表示させたいときのみショートコードを使って表示させるようにできます
- 管理画面の投稿(固定ページ)一覧に結果を表示できます
- 管理画面のダッシュボードに全体の統計情報を表示できます
- 投稿(固定ページ)ごとに2択の設問や、フィードバック送信後のメッセージ、表示する文字列などを個別設定できます
- フィードバックがあったことを管理者へメールで通知できます
- フィードバックのお礼メールを投稿者へ送信(フォーム上でメールアドレスが入力された場合)できます
- cookieとセッションを使って重複フィードバックを防ぐことができます
- ショートコードを使うことで、そのページへのフィードバック(文字による意見)を表示したり、他のページで表示させたりすることができます
※8.9に関してはメールを送信しないようにすることも可能(デフォルトは送信しない)
通常のコメントや問い合わせフォームでフィードバックを得るのと決定的に違うところは5.6のレポート機能。
ダッシュボードにはこんな感じで結果をまとめて見ることができます。
※上の画像は公式ページの引用です
また、投稿(固定ページ)一覧ではこのように数の把握ができます(赤枠部分)。
実際に試用した感触としては、似たようなカスタマーレビュー系のプラグインの中で、簡単に設置・設定できる類のプラグインではないかと思います。
本ページを最後に編集したときの環境・バージョンなど
プラグインは製作者によって日々更新されていくため、この紹介記事が最新バージョンのものであるとは限りません。参考までにこの記事の最終更新日時点におけるテスト環境、プラグインバージョン、プラグイン導入時の留意点などを記載しておきます。
プラグインを使用(試用)したテスト環境
- テストサーバー:カラフルボックス
- WordPressのバージョン:5.8.3(6.0RC2でも動作確認しました)
- PHPのバージョン:7.4.6(8.0でも動作確認しました)
- テーマ:HABONE(本サイトでも使用しているオリジナルテーマです)
- プラグインのバージョン:本記事で紹介しているバージョン 4.5.17/最新バージョン 公式サイトで “helpful” は配布されていません
- 公式サイト(wordpress.org上):https://wordpress.org/plugins/helpful/
- 公式サイト(作者サイト):
本記事を参考にWordPressサイトへプラグインの導入を検討される方へ
WordPressは古くから無料で配布されているサイト作成ツール(CMS)で、随時改良が加えられており、さまざまなバージョンが存在します。
さらにWordPressを動かすためのプログラムであるPHP、サイトのデータを保存しておくためのデータベースについても様々なバージョンがあります。
そしてWordPress本体同様にプラグインについてもさまざまなバージョンが存在します。
本記事を参考にプラグインの導入をお考えの方は、以下に留意の上でインストールするようにしてください。
- テスト環境での動作に基づいた紹介記事ですので、すべての環境で正常に動作するかどうかは不明です
※本記事の内容についてはページ内に記載しているプラグインバージョンのものになります。現在のバージョンと異なる場合、機能や日本語対応の状況などが異なる場合があります。
※また、テスト環境、テストしたプラグインバージョン等の表示が本文内にない場合、ページタイトル下にある最終更新日当時の情報となりますので、現在のバージョンでは全く違う機能となっているかも知れません。 - プラグインに無料版と有料版(Pro版)がある場合、特に記載がなければ無料版の情報のみを紹介しています
- このページでプラグインを使用する際に必要なショートコードやコードなどは、コピーして使用することができますが、環境によっては記号などが文字化けすることがあります。コピーしたのに動作しない場合は特に「”」「’」などの記号を入力し直してみてください。
- プラグイン本体の動作不具合や質問などは公式サイトのフォーラムなどで行ってください(ここでは質問にお答えすることはできません)
【Helpful】プラグインの設定画面や表示画面の日本語化と翻訳
当サイトで私が翻訳した【Helpful】プラグインの日本語化ファイルを提供しています。翻訳ファイルについての詳しい説明は以下のページをご覧ください。
※翻訳することで設定が容易になり、重要な項目の設定漏れも少なくなりますから日本語化をお勧めします。
詳しく教えていただけませんでしたが、一部の環境では動作しないことがあるようですので、まずはプラグインを有効化後、投稿や固定ページへショートコードを入れ、動作することを確認してから翻訳ファイルの導入を検討ください
【Helpful】プラグインのインストールと設定
インストール方法
インストールはプラグインの新規追加でプラグイン名を入力して検索してインストールするか、WordPressのプラグイン公式配布ページからダウンロード後、管理画面からアップロードインストールしてください(プラグインの公式ページは本ページ内記載のリンクをクリック、もしくは、WordPress公式サイトで検索してください)。
WordPressを使い始めて間もない方(初心者の方)は、より詳細なプラグインのインストール手順や、インストール時に起こる問題などへの対処方法をまとめた【WordPress】プラグインのインストール&追加方法とエラー対処の方法も併せてご覧ください。
基本的な設定方法と使用方法
項目が多いので、しっかり設定したい方には日本語化をおすすめしますが、大まかに必要な設定としては、以下の項目になろうかと思います。
- どの投稿タイプで自動的に本文下へフィードバックフォームを設置するか?(または設置しないか?)
- 投票による回答の他に、フィードバック(文章)での意見を受け付けるか?
- 表示する文字列をどうするか?
- フィードバックがあったとき管理者へ通知メールを送るか?
- フィードバックがあったとき送信してくれた方へ通知メールを送信するか?(フォーム中にメールアドレスの入力をした方にのみ送信)
- 画面の見た目(デザイン)をどうするか?
- 重複投稿に対する処理をどうするか?
注意すべき点としては、〇〇する(〇〇しない)という設定がたくさんあり、例えばフィードバックを送信してくれた方へのお礼メールを送る設定をしていても、メールアドレス入力欄を表示できなくすることができる(メールアドレスを収集しないのですから、当然メールが送られることはない)といった設定もできてしまうので、十分にテストをして設定する必要があることです。まあ、こういう点はこのプラグインに限らず存在するものですから仕方ないと思います。
また、フィードバックフォームを自動的に本文下へ表示させないようにしていても、
[helpful]
というショートコードを使うと、任意の投稿や位置にフォームが表示できるようになっているので、自動表示させるか否かはサイトルールとして決めておいた方がいいでしょう。
以下公式ページに掲載されている画像です(リンク挿入で表示しています)。
フィードバック一覧をフロントページで表示する方法
この記事を執筆した当初にはなかった機能でしたが、文字で入力されたフィードバック情報を、コメントの一覧のような感じで表示できる機能が追加されました。
以下のショートコードを挿入することで、一覧表示させることができます。
[helpful-feedback]
また、ショートコードを以下のようにすることで別のページへ特定ページでのフィードバック一覧も表示できるようになっているようです(未確認)。
[helpful-feedback post="〇〇"]
※post=”〇〇”の〇〇は目的となる投稿・固定ページのIDです。
参考:How to display feedback in a page(【Helpful】公式フォーラム)
フィードバック(文章)の入力を任意にする方法
このプラグインでは、設定により、「はい」「いいえ」の選択の後に自由入力できる投稿フォーム(フィードバックフォーム)を表示し、選択した理由を投稿してもらうことができるようになっています。
このフォームの入力はデフォルトで必須になっているものの、未入力でも送信はできる状態になっていて、その場合、送信後のメッセージが出ないため、評価した人は戸惑うかもしれません。
これについては公式フォーラムで過去に言及されていて、プラグイン作者の考え方として「一応必須にしておいて、空で送信できてしまった..という状態にしておきたい」という結論になっていました。
送信後メッセージが表示されないのが気になる方は、以下の方法で入力フォームの入力を必須ではないようにできます。
- プラグインフォルダにある「templates」フォルダをパソコンへダウンロードします
- フォルダ名が有効化しているテーマのフォルダと被る場合には別名へ変更します
- 2のフォルダを有効化しているテーマ内へアップロードします
- 「feedback.php」の32行目付近にあるコードを以下のように書き換えます
<書き換え前のコード>
<textarea name="message" id="message" required></textarea>
<書き換え後のコード>
<textarea name="message" id="message"></textarea>
要はフォームの必須指定「required」を削除するだけです。テーマへテンプレートをコピーするのは、プラグインの更新によって上書きされないためです。
必須であることを示す「*印」については30行目付近にある
<req>*</req>
を削除すればOKですが、必須マークは残しておいたほうが意見が得られるかもしれません..。
複数のページで共通のフィードバックを受け付ける(統合する)には
作者のサイトにあるShortcodesというページには、ショートコードにパラメーターを付加することで、タイトルや選択肢の文字列を変更して、柔軟に対応できる例が紹介されています。
このページに書かれているパラメーターには「post_id」というのがあったので、以下のように複数のページに対して「post_id=’xxx’」というパラメーターをつけてみたところ、
[helpful page_id='xxx']
複数ページから収集した「はい」「いいえ」の集計と、フィードバックの統合をすることができました。
「xxx」は実在する投稿や固定ページのIDを指定します
この機能について、バージョン4.5.16の段階で投票数が集計されなかったため、私から公式フォーラムへ連絡をさせていただき、4.5.17で改善されました。
使用していないページで余分なスクリプトやCSSを読み込まないようにする方法
【Helpful】に限らず、WordPressのプラグインは基本的にどのページでも正常に動作するようにすることが前提となっているため、フォームや一覧を表示していない投稿や固定ページでも、動作させるためのスクリプトとデザインコード(CSS)が読み込まれるようになっています。
テストではそれほど大きな処理はないようではありましたが、不要なものはできるだけ読み込まないようにすることがWordPressサイト動作正常化(表示高速化)に役立ちます。
自動で出力する投稿タイプのみスクリプトとCSSを読み込むようにする
「Settings」メニューの「Post Type」タブで、投稿(post)のみにチェックが入っている場合には、テーマのfunctions.phpへ以下を追加することで、投稿のみスクリプトとCSSを読み込ませることができます。
/***** helpfulプラグインのカスタマイズ *****/
/* 一旦CSSとスクリプトをdequeueする */
function ha_helpful_dequeue_css_script(){
wp_dequeue_style( 'helpful' );
wp_dequeue_script( 'helpful' );
}
add_action('wp_enqueue_scripts','ha_helpful_dequeue_css_script');
/*** 投稿のみ有効にする ***/
function ha_reenqueue_helpful_css_script(){
if( is_singular(array('post')) ) {
wp_enqueue_style( 'helpful' );
wp_enqueue_script( 'helpful' );
}
}
add_action('wp_enqueue_scripts','ha_reenqueue_helpful_css_script');
特定のカスタム投稿タイプだけというときは、上記コードの’post’を’カスタム投稿タイプのスラグ’へ変更します。また、複数の投稿タイプを指定するときは、’post’,’カスタム投稿タイプ1’といったようにカンマで区切って指定します
ショートコードがある場合のみスクリプトとCSSを読み込むようにする
ここでは、【helpful】ショートコードの有無によってスクリプトとCSSの読み込みを制御するコードを紹介しておきます。
以下のコードをテーマのfunctions.phpへ追加することで制御できるようになります
この方法はショートコードを使用する場合のもので、設定画面で投稿や固定ページ本文下に自動でフォームを表示する設定になっている場合、不具合を起こしますのでご注意ください
/***** helpfulプラグインのカスタマイズ *****/
/* 一旦CSSとスクリプトをdequeueする */
function ha_helpful_dequeue_css_script(){
wp_dequeue_style( 'helpful' );
wp_dequeue_script( 'helpful' );
}
add_action('wp_enqueue_scripts','ha_helpful_dequeue_css_script');
/* ショートコードがある場合に有効にする */
function ha_helpful_shortcode_enqueue_scripts() {
global $post;
$include_reuse = do_blocks( $post->post_content );
if( is_a( $post, 'WP_Post' ) && has_shortcode( $include_reuse, 'helpful') ) {
wp_enqueue_style( 'helpful' );
wp_enqueue_script( 'helpful' );
}
}
add_action( 'wp_enqueue_scripts', 'ha_helpful_shortcode_enqueue_scripts' );
本記事の更新(変更)履歴
更新日 | 更新内容 |
---|---|
2020年10月 5日 | 記事公開しました |
2021年12月15日 | バージョン4.4.66を試用した内容へ更新しました ショートコードのみでの運用時に不要なスクリプトとCSSを読み込まないようにする方法を追加しました |
2022年 5月15日 | ショートコードのみでの運用時に不要なスクリプトとCSSを読み込まないようにする方法のコードを変更しました |
2022年 5月19日 | ショートコードのみでの運用時に不要なスクリプトとCSSを読み込まないようにする方法のコードを再利用ブロックにショートコードがあった場合を考慮したものへ変更しました |