WordPressにWeb拍手を設置する

創作系サイト、同人サイトなどでよく利用されている「Web拍手」というプログラムがありますが、WordPressのプラグインで同じように利用できるものが無いかいくつか試してみたところ、最も探している条件に近いものに「WP WebClap」というプラグインがあったので導入してみました。
開発がWordPress 3.6.0の頃で止まっているせいか現在のバージョン(4.4.2)では若干不具合があるようですが、ある程度手を加えたところ無事利用できましたので、その時の手順を備忘録を兼ねてご紹介します。

設置サンプル

今回、次のような条件でプラグインを探しました。

  • 拍手ボタンをクリックしたら拍手完了画面をポップアップで表示する
  • 最大10回まで連続で拍手ができる
  • 拍手1回めから10回めまで異なる画像を表示させたい
  • 拍手完了画面のコメント欄に「要返信」のチェックボックスを追加したい
  • WordPressの管理画面内で拍手のデータを参照したい

以上の条件に従って実際にカスタマイズして設置してみたサンプルです。
次項からこの設置手順を順を追って説明します。

(Demo)

WP WebClap プラグインのインストール

WordPressの管理画面で「プラグイン」→「新規追加」から「wp-webclap」で検索するか、WordPress公式サイトからzipファイルをダウンロードしてインストール・有効化してください。

wp_clap01

プラグインの設定

「設定」→「web拍手プラグイン設定」を開き、次の通り設定します。
太字が変更箇所、その他はデフォルト値です。

web拍手の設定

  • Web拍手種類「内蔵」
  • ボタン挿入方法「手動」
  • 処理ページ(固定ページURL)「webclap
  • 表示方法「画像」「新しいウインドウで開く」
  • デフォルトでボタンを有効にする「ON
  • 標準のボタンテキスト「web拍手ボタン」
  • ボタン画像通常時「clapBtnOff
  • ボタン画像ホバー時「clapBtnOn

内蔵web拍手使用時の設定

  • 名前入力設定「可能
  • ボタン表示位置「両方」
  • 解析ページの必要権限「管理者」
  • 拍手ボタンに拍手数を追加する「無効」

拍手完了ページの作成

固定ページの作成

拍手ボタンをクリックした後に表示される拍手完了ページを作成します。
固定ページの新規追加で、タイトルを「拍手完了」スラッグを「webclap」、本文にショートコード「[webclap]」を入力して保存します。
※タイトルは任意で構いません。

テンプレートファイルの作成

次に上記の固定ページ用のテンプレートファイルを作成します。

以下の内容をテキストエディタで作成し、「page-webclap.php」のファイル名で使用中のテーマディレクトリに追加します。

▼page-webclap.php (/wp-content/themes/使用中のテーマ/page-webclap.php)

拍手完了ページ用のcssファイルはテーマディレクトリの「css」ディレクトリ下に保存します。

▼clap.css (/wp-content/themes/使用中のテーマ/css/clap.css)

Web拍手ボタンの設置

テーマのヘッダー、フッター、サイドバーなどWeb拍手ボタンを表示したい箇所のテンプレートファイルを開き、以下の記述を追加します。

以上で、基本の設置作業は完了です。

次に拍手回数に応じて表示する画像を切り替えるカスタマイズと、細かな調整を行います。

拍手完了ページのカスタマイズ

上記で拍手完了ページを作成した際の本文には「[webclap]」のみ入力しましたが、これをテキストモードで以下の内容に再編集して保存します。
「$clap_img_dir」と「$clap_contents」の設定値は任意に編集してください。

※上記の場合、拍手完了ページ用の画像は使用中のテーマディレクトリの「images」→「clap」に格納します。(/wp-content/themes/使用中のテーマ/images/clap/clap01〜10.jpg)

※本文欄に記述したPHPコードの実行には「PHP Execution」等のプラグインをインストールしておく必要があります。

※ビジュアルモードに切り替えた際には、PHPコードが自動的に書き換えられてしまいますので、ページを編集する際や保存時には注意してください。書き換えを避けるにはプラグイン(Disable Visual Editor WYSIWYG)の追加、もしくは固定ページ全体でビジュアルエディタの使用を停止するコードスニペットをfunctions.phpに追加するなどの方法があります。

テンプレートの修正

次に、名前欄を「要返信」のチェックボックスに置き換えて利用するために、ショートコード「[webclap]」で出力されるフォーム部分をカスタマイズします。

拍手完了画面のフォーム部分のテンプレート

「wp webclap」プラグインの「templates」内にある「process_success.html」ファイルをテキストエディタで開いて以下の内容に書き換えます。

▼process_success.html 
(/wp-content/plugins/wp-webclap/templates/process_success.html)

Web拍手ボタン出力時のテンプレート

Web拍手ボタンをクリックした際にポップアップするサブウインドウのサイズを調整するには、以下のファイルの18行目あたりのサブウインドウの設定を書き換えます。

▼tag_internal_image.html 
(/wp-content/plugins/wp-webclap/templates/tag_internal_image.html)

  ↓

※「web拍手プラグイン設定」でWeb拍手ボタンの「表示方法」を「ボタン」に設定した場合は、「tag_internal_button.html」ファイルを、「テキスト」に設定した場合は「tag_internal_text.html」ファイルを編集します。

カウントの不具合の修正

最後に、プラグインファイル本体を一部修正します。
「wp webclap」プラグインの「Wp」→「WebClap」内にある「Core.php」ファイルをテキストエディタで開いて、100行目あたりにあるカウント数の上限を下記のように10から11に書き換えます。

▼Core.php (/wp-content/plugins/wp-webclap/Wp/WebClap/Core.php)

  ↓

10回目の拍手完了画面の表示には「$clap_count」を取得して表示を切り替えるように、前項で拍手完了ページを作成した際に以下のように対応済みです。

▼拍手完了ページ(固定ページ)

その他の注意点

プラグインがWordPressの最新版に対応していないのでバージョンに拠る点もあるかと思いますが、上記のカスタマイズをした際も含めて、WordPress 4.4.2 の時点で気づいた不具合をいくつか以下にまとめましたので参考にしてください。

  • 「web拍手プラグイン設定」で「デフォルトでボタンを有効にする」の項目は常に「ON」にしないとWeb拍手ボタンが表示されません。
  • 「名前」欄を「要返信」に変更した際には、「web拍手プラグイン設定」の「名前入力設定」を「必須」にすると挙動が不安定になるので、必ず「可能」または「不可」に設定してください。
  • 「web拍手プラグイン設定」画面下の「全ての拍手データを削除」ボタンをクリックしても、データが初期化されません

データの初期化方法

データの初期化については、プラグインフォルダ内の「/Wp/WebClap/Administration.php」を確認すると153行目の指定先の「/query/clear_entry_count.sql」が存在しないようなので、ファイルを追加すればボタンの機能を有効にできるかと思います。
自分にはファイルの書き方がよくわからないので次のような手順で「phpMyAdmin」からデータを初期化しました。

wp_clap09【1】「phpMyAdmin」から「xxxxx_webclap_comments」(xxxxxはWordPressインストール時のテーブル接頭辞)を選択して「SQL」タブをクリックします。

wp_clap10【2】「DELETE」ボタンをクリックまたは以下の命令文を入力して、「実行」ボタンをクリックしてデータを削除します。

wp_clap11【3】もう一度「SQL」タブをクリックして、以下の命令文を入力して「実行」ボタンをクリックしてデータのIDを初期化します。

wp_clap12以上でデータの削除とテーブルの初期化は完了です。

おまけ

wp_clap13「名前」欄を「要返信」のチェックボックスにカスタマイズした際に、web拍手解析の画面の表示が気になる場合は、「admin_analysis.html」の135行目を以下のように変更してください。

▼admin_analysis.html (/wp-content/plugins/wp-webclap/templates/admin_analysis.html)

  ↓

wp_clap14これでスッキリすると思います。

PR

DO WP 管理人