WordPressプラグイン「Send Chat Tools」

Send Chat Tools

Send Chat ToolsはWordPressに新規コメントが投稿された時、チャットツールにそのお知らせを送信するプラグインです。

※バージョンアップでコメント以外（WordPressコアファイルやテーマ、プラグインのアップデート情報等）の送信も予定しています。

Send Chat Toolsについて

Send Chat Toolsはインストールする事で新規にコメントを受け付けた際にチャットツールにコメントの内容が送信されます。

WordPress標準機能としてコメント時にメール送信されますが、昨今のビジネスシーンでは大概何かしらのチャットツールを使用していると思います。

チャットツールはスマートフォン等へのプッシュ通知機能があり、メールに比べコメントの存在に気づきやすいメリットがあります。

また、複数のWordPressサイトを運営しているとサイトごとにメールアドレスを分けている事も多く全てのメールアドレスを日々確認する事は大きなストレスです。

全て一つのチャットツールに送信する事で、全サイトのコメント対応が一元化できます。

Send Chat Toolsで対応できること

Send Chat Toolsは以下のサービスに対応しています（v1.0.0現在）。

  • 新規コメントを受け付けた場合の通知
  • 通知上からコメントのURLへ直接アクセス
  • 通知上からコメントの承認ページへ直接アクセス
  • WordPressコア、テーマ、プラグインのアップデートがあった場合の通知

エラー時の挙動

外部のチャットツールを使う関係上、ネットワークやサーバーになんらかの問題があった場合正常に通知が行えない場合があります。

そのようなケースを想定して、Send Chat Toolsを用いて正常な通信ができなかった場合WordPressの登録メールアドレス宛にコメント等の内容とエラーで送信ができなかった旨を記載したメールを送信し、受け付けたコメントのお知らせ等をロストしないように配慮してあります。

この設定はWordPress->ディスカッション->自分宛のメール通知の2項目をオフにしていても強制的に適用されます。

そのため、通常時はコメントに関するメールを受信しないが障害等でチャットツールに送信されなかった場合に限りメール受信することが可能です。

WordPress対応を謳うサーバーではまずありえませんが、標準のWordPressによるメール送信が行えないサーバーの場合この機能は使用できません。

Send Chat Toolsに対応しているチャットツール

Send Chat Toolsは以下のチャットツールに対応しています（v1.0.0現在）。

  • Slack
  • Discord
  • Chatwork

なお今後のアップデートで以下のチャットツールに対応予定です。

  • Microsoft Teams

※各種チャットツールの状況に応じて開発・サポートを停止する場合があります

Send Chat Toolsのインストール

Send Chat ToolsはWordPress公式ディレクトリに登録されているプラグインです。

ご自身のWordPressサイトの管理メニューからプラグインを検索してインストールしてください。

また、最新版はGitHubでも公開しています。

何らかの理由でWordPress公式ディレクトリからインストールできない場合、以下のページからダウンロードしてインストールしてください。

Releases · braveryk7/send-chat-tools – GitHub

必ず最新バージョンの「send-chat-tools.zip」をダウンロードしてください。

  • Source code (zip)
  • Source code (tar.gz)

この2つは実行に直接関係ないファイルも同梱されている為、余計なリソースを消費してしまいます。

導入必須要件

Send Chat Toolsは以下の環境で動作することを確認しています。

  • WordPress Version 5.5.1以上
  • PHP Version 8.0.0以上

特にPHPに関しては8.0.0以下の場合利用ができません。

アンインストール

Send Chat Toolsを利用しなくなった場合、プラグイン管理ページから無効化と削除が行えます。

なお削除のタイミングでSend Chat Toolsが利用しているデータベースは自動で削除されるので、別途データベースクリーンプラグイン等を利用しなくても削除するだけでOKです。

何らかの理由でSend Chat ToolsをFTPやファイルマネージャー上から削除する場合、データベース側は以下のwp_options内のカラムも削除してください。

  • sct_iv
  • sct_use_user_id
  • sct_use_slack
  • sct_slack_webhook_url
  • sct_send_slack_author
  • sct_slack_log
  • sct_send_slack_update
  • sct_use_discord
  • sct_discord_webhook_url
  • sct_send_discord_author
  • sct_discord_log
  • sct_send_discord_update
  • sct_use_chatwork
  • sct_chatwork_api_token
  • sct_chatwork_room_id
  • sct_send_chatwork_author
  • sct_chatwork_log
  • sct_send_chatwork_update
  • sct_cron_time
  • sct_db_version

上記のstc_*オプションは全てv1.3.0で削除され、sct_optionsカラムに統一されました。

合わせてSend Chat Toolsの送信ログデータが保存されている、以下のテーブルも削除してください。

  • wp_sct

**_sctテーブルはv1.3.0で削除され、sct_logsカラムに移行しました。

データベースの操作は慣れていないと大変危険です。

不安な方、よくわからない方はデータベースを操作しないで下さい。

WP-Cron

Send Chat ToolsはWordPressコア、テーマ、プラグインアップデートチェックを毎日定時で行うよう設定が行えます（標準では毎日18:00ですが、管理画面上で時刻を変更できます）。

この機能はWordPressのWP-Cronという機能を用いておりますが、アンインストールと同時にWP-Cronに登録された予約も削除するように設定してあります。

不必要なデータは残さないよう配慮していますのでご安心ください。

Send Chat Toolsの使い方

Send Chat Toolsはインストール（有効化）完了後、各種チャットツールのAPIキーまたはWebhook URLが必要になります。

各種チャットツールに必要なAPIキーまたはWebhook URLの取得方法は以下のマニュアルをご覧下さい。

Slack Webhook URLを取得して連携する

Send Chat ToolsにSlack Webhook URLを追加する手順
WordPressプラグインのSend Chat ToolsにSlackのWebhook URLを追加する手順を解説します。 なお基本的に当プラグインは自分が管理している専用のワークスペースを想定しています。 複数の方と共有のワークスペース...
www.braveryk7.com
2022.07.24

Discord Webhook URLを取得して連携する

Send Chat ToolsにDiscord Webhook URLを追加する手順
WordPressプラグインのSend Chat ToolsにDiscordのWebhook URLを追加する手順を解説します。 なお基本的に当プラグインは自分が管理している専用のサーバーを想定しています。 複数の方と共有のサーバーの場合、...
www.braveryk7.com
2022.07.24

Chatwork APIトークン/ルームIDを取得して連携する

Send Chat ToolsにChatwork APIトークン/ルームIDを追加する手順
WordPressプラグインのSend Chat ToolsにChatworkのAPIトークン/ルームIDを追加する手順を解説します。 なお基本的に当プラグインは自分が管理している専用のチャットページを想定しています。 複数の方と共有のチャ...
www.braveryk7.com
2022.07.24

管理画面

設定は管理画面左側の設定→Send Chat Tools設定から行えます。

Send Chat Toolsの設定

設定項目は主にAPIキーまたはWebhook URLを入力し、使用するにチェックを付ければOKです。

自分自身がコメントした際に送信したくない場合は自分自身に送信しないにチェックを入れてください。

ユーザーIDが変更された場合

Send Chat Toolsでは、一部の設定で管理画面上で設定を更新したユーザーのユーザーデータを使用しています。

そのため、WordPressユーザーの作り直しやサイト売却等でWordPressのユーザーIDが変更になった際は変更後改めて設定変更ボタンを押下しないと機能が停止してしまいます。

この設定は直接チャットツールを操作できてしまうAPIキー等を保護するために重要な機能なので、大変お手数ではございますがユーザーIDが変更になった際は改めて設定画面の設定を保存ボタンを押下して下さいますようお願い申し上げます。

この設定はv1.3.0で廃止されました。

開発者向け機能

Send Chat Toolsではテーマ・プラグインデベロッパー向けに積極的に機能提供を行い、みんなでWordPressエコシステムを盛り上げて行ければ良いと考えています。

そこでv1.3.0でテーマ・プラグインの更新通知用にsct_developer_notifyフックを公開しました。

テーマやプラグインを更新した時に、ユーザーがSend Chat Toolsを使用していれば更新内容を送信するフックです。

更新内容をエンドユーザーに届けるのは中々難しいですが、皆様の日々の素晴らしい開発にわずかでも尽力できれば幸いです。

sct_developer_notifyフックの詳しい使い方は以下の記事をご覧ください。

sct_developer_notifyフックマニュアル
Send Chat Toolsはv1.3.0でsct_developer_notifyを公開しました。 WordPressテーマ、プラグイン製作者がSend Chat Toolsユーザーにアップデートメッセージを送付する事が可能です。 sc...
www.braveryk7.com
2022.07.22

Send Chat Toolsのロードマップ

Send Chat Toolsでは今後以下の機能追加を予定しています。

  • Discordの対応（v1.0.0で実装済）
  • Chatworkの対応（v0.1.0で実装済）
  • Microsoft Teamsの対応
  • WordPressコアファイル、テーマ、プラグインアップデート通知（v1.0.0で実装済）
  • メールフォームプラグインContact Form 7を使用している場合にメール内容を通知
  • 商品リンク管理プラグインRinkerを使用している場合に商品リンク切れを通知（v1.5.0で実装）
  • ログイン通知（v1.5.0で実装）
  • エラー時にメール送信を用いて一切の通知が届かない状況の回避（v0.1.2で対応済み）

レビューのお願い

もしSend Chat Toolsを利用して下さり、「ここが便利！」「ここが不便！」等のご感想がありましたら率直なレビューを頂ければ嬉しいです。

レビューは以下のリンクから簡単に行えます（wordpress.orgのアカウントが必要です）。

今後の開発のモチベーションになりますので、ぜひ忌憚のない意見をお聞かせ下さい。

[Send Chat Tools] Reviews | WordPress.org

Send Chat Tooolsの更新履歴

Send Chat Toolsの更新履歴をご確認頂けます。

v1.5.3

更新日：2023年5月14日

重要

  • v1.4.0以降はPHP8.0が必須です。PHP7系以前の環境では当プラグインは利用できません。

新機能

  • アップデート通知にJIN:Rを追加しました。

改善

  • ログの生成・保存の処理を変更しました。

修正

  • Cocoonが有効化されている場合アップデート通知が送信されない問題を修正しました。
  • アンインストール時にRinker通知のWP-Cronを削除するよう修正しました。

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/v1.5.3

v1.5.2

更新日：2023年5月8日

重要

  • v1.4.0以降はPHP8.0が必須です。PHP7系以前の環境では当プラグインは利用できません。

修正

  • Rinker終売通知で終売フラグが立っていないのに通知される問題を修正しました。

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/v1.5.2

v1.5.1

更新日：2023年5月8日

重要

  • v1.4.0以降はPHP8.0が必須です。PHP7系以前の環境では当プラグインは利用できません。

修正

  • wp-cron設定を修正しました。
  • 翻訳ファイルが欠落していた問題を修正しました。

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/v1.5.1

v1.5.0

更新日：2023年5月7日

重要

  • v1.4.0以降はPHP8.0が必須です。PHP7系以前の環境では当プラグインは利用できません。

新機能

  • ユーザーがログインした際に通知を行う機能を追加しました。
  • 商品管理プラグインRinkerでAmazon/楽天の商品が取り扱い終了になった場合通知する機能を追加しました。

改善

  • 設定画面に項目が増えたので、ラベルや見出しの追加で分かりやすくしました。
  • コメント通知をオフにできる機能を追加しました。
  • 設定画面でチャットツールを使用するにチェックが入っていない場合、他の設定項目を操作できないように改善しました。
  • Discordの通知に絵文字、文字装飾を加え視認性を向上させました。

修正

  • コメント投稿者の呼称をAuthorからCommenterに変更しました。

開発

  • 送信データの生成を各チャットツールごとに分割し、メンテナンス性を向上させました。
  • 主に送信メッセージの生成で内部設計を見直しました。

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/v1.5.0

v1.4.0

更新日：2023年4月18日

重要

  • PHP7系のサポートを終了しました。このプラグインはPHP8以上でないとアクティベートできません。
  • チャットログの上限が300件に変更されました。

改善

  • PHPのバージョン判定ロジックを見直しました。
  • 各種メソッドのテストを拡充しました。

開発

  • WordPress純正のwp-env環境を導入しました。

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/v1.4.0

v1.3.1

更新日：2023年3月15日

重要

  • 次回のアップデートでPHP8.0以下の場合、プラグインが自動停止され使用できなくなります。アップデートは4月15日頃に行われる予定です。
  • 次回のアップデートでログの上限が1,000件から300件に削減されます。必要であればバックアップを取得してください。

改善

  • WordPress6.2に対応しました。
  • 特定のデベロッパーメッセージを拒否する機能を実装しました。
  • @wordpress/api-fetchパッケージを採用し、より高速で安全に設定ページを使用できるようになりました。
  • データロード中の画面をシンプルなデザインに変更しました。
  • アップデート通知時刻の変更を基本設定タブに移行しました。これに伴いアップデート通知タブは廃止されました。
  • ログの出力機能を実装しました。クリップボードコピー、テキスト/CSV出力を選択できます。
  • WordPress REST APIでデータ取得が失敗した時、エラーメッセージを表示するようになりました。

修正

  • PHPにAPIのエラーが出力されていた問題を修正しました。
  • コードのリファクタリングを実施しました。
  • 一部のレガシーなコードを削除しました。
  • アップデート時に一部の環境で重大なエラーが起こる問題を解決しました。

開発

  • 開発環境を再整備しました。

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/v1.3.1

v1.3.0

更新日：2022年2月27日

重要

  • 次回のマイナーアップデート（1.4.0）でPHP8.0以下はサポートされなくなります。アップデートは4月を予定しています。

改善

  • 管理画面をReactに切り替えモダンになりました。WordPressコンポーネントを使用した、皆さんに馴染みにあるデザインです。
  • チャットツール個別のログを3件まで保存するようになりました。
  • WordPressのダッシュボードにSend Chat Toolsのウィジェットが設置されました。
  • 次回のアップデートでサポートするPHPのバージョンが変更される場合、警告を表示します。
  • プラグインのアップデート時に更新内容を送信します。
  • PHPの内部設計を大幅に見直しました。
  • sctから始まる多くのオプションを廃止し、sct_optionsカラムに統一されました。
  • sctテーブルを廃止し、sct_logsカラムに統一されました。
  • 開発者向けにsct_update_notifyフックを公開しました。

修正

  • APIの値の暗号化を廃止しました。
  • APIの値が正常ではない場合、送信されなくなりました。
  • WordPress本体の設定変更はSend Chat Toolsの設定画面からできなくなりました。

開発

  • 将来のアップデートに向けて開発環境を大幅に整備しました。
  • PHPUnitを導入して厳密なテスト環境を構築しました。
  • PHPStanを導入して静的解析環境を構築しました。
  • WordPressコンポーネント×TypeScript開発環境を構築しました。
  • ESLint、Stylelint、PHP_Codesnifferの設定を見直しました。
  • 小さなツールを採用しました（zip.sh, git hooks）

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/v1.3.0

v1.2.0

更新日：2021年7月24日

機能の追加

  • SlackメッセージのUI（Block Kitを採用）

改善

  • 対応するWordPressのバージョンが反映されていない問題

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/1.2.0

v1.1.1

更新日：2021年7月18日

WordPress5.8に対応

機能の追加

改善

  • DiscordのOGPを非表示に修正
  • 不要なオプションカラムを削除

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/1.1.1

v1.1.0

更新日：2021年6月27日

機能の追加

改善

  • APIが未入力なら送信処理をスルーする処理

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/1.1.0

v1.0.0 メジャーアップデート

更新日：2021年6月26日

✨メジャーアップデート

機能の追加

  • Discordに対応
  • WordPressコア、テーマ、プラグインのアップデート通知機能
  • API値の自動チェック機能
  • 通信ログ機能

改善

  • 管理画面のUI

修正

  • 正常に送信されてもエラーメールが送信される場合がある問題

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/1.0.0

v0.1.6 β

更新日：2021年5月30日

  • 暗号化ロジックを修正
  • typo修正

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/0.1.6

v0.1.5 β

更新日：2021年5月30日

  • エラーコード1000を追加

エラーコード1000はAPIの接続自体ができなかった場合に出力されます。

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/0.1.5

v0.1.4 β

更新日：2021年5月30日

  • チャットツールを使用にチェックされているが必要な値が未入力な場合の例外処理を追加

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/0.1.4

v0.1.3 β

更新日：2021年5月30日

  • WordPress標準のコメント通知メールの設定をSend Chat Toolsの設定ページに追加

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/0.1.3

v0.1.2 β

更新日：2021年5月30日

  • チャットツールに正常に送信できなかった場合メール送信する処理を追加

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/0.1.2

v0.1.1 β

更新日：2021年5月29日

  • データベース処理の追加（Chatwork関連）
  • Chatworkの説明を追加

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/0.1.1

v0.1.0 β

更新日：2021年5月29日

マイナーアップデート

  • Chatworkに対応
  • アイコン・バナー・スクリーンショット追加
  • 軽微な修正

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/0.1.0

v0.0.1 β

更新日：2021年5月26日

  • βバージョンリリース

GitHub Release:https://github.com/braveryk7/send-chat-tools/releases/tag/0.0.1

ホーム
ポートフォリオ
タイトルとURLをコピーしました