WordPressプラグインのデバッグを手伝う方法

JoomUnitedの開発者は、あなたのプラグインが可能な限り最適な方法で動作するよう常に取り組んでいます。もちろん、場合によっては何らかの種類の障害が発生することがあります。例えば、サードパーティのプラグインが原因で生成される非互換性などです。こうした種類の障害が発生したとき、私たちは何を望むでしょうか？もちろん、迅速に解決されることです...    

この記事では、開発者がエラーを迅速に理解して解決できるよう、正しい情報を伝える方法を説明します。この記事は、問題が発生した際に開発者へ適切な情報を提供するために従う3つのステップに分けて解説します。

• デバッグログを有効にする
• トラブルシューティングプラグインをインストールしてください
• JavaScript エラーを確認する

WordPressのデバッグおよびログシステムを有効にする

まず最初に、 WP_DEBUG とは何かを知る必要があります。Wikipedia にあるように、「 WP_DEBUG は PHP の定数（永続的なグローバル変数）で、WordPress 全体で「デバッグ」モードを有効にするために使用できます。デフォルトでは false と想定されており、通常は WordPress の開発用コピーの wp-config.php ファイルで true に設定されます。」

ご覧のとおり、 WP_DEBUG はデフォルトでは オフ になっている定数ですが、一時的なデバッグ目的で オン にすることができます。 

さらに、 WP_DEBUG_LOG という別の PHP 定数があり、これを使うとプラグインのすべてのエラーを含むテキストファイルを自動的に作成できます。それを開発者に送信します。  

これを正確に有効にする方法と、プラグインでエラーが発生した場合にどのように表示されるかについて説明します。この例では WP Meta SEO を使用しますが、すべてのプラグインで同じ手順を実行できます。このケースでは WP Meta SEOで問題が発生していますが、どのような問題でもかまいません。そこで、 wp-config.php ファイルを開きます。お好みのテキストエディタソフトウェア（例：Notepad、Visual Studio Code、Brackets）で行うことができます。単に wp-config.phpを開いてください。

ファイルは、WordPressサイトがインストールされているサーバーのルートにあります。.

テキストエディタで開き、 CTRL + F を押すか、 編集 > 検索… をクリックすると、検索したい単語を入力できるボックスが表示されます。今回は 「WP_DEBUG」 と入力して、次の文字列が見つかるまでEnterを押します：
「define( 'WP_DEBUG', false )」

その行に来たら、“false”を削除してtrueと入力し、Enterをクリックして、次の行にdefine( 'WP_DEBUG_LOG', true ); をコピーしてファイルを保存してください。次の画像のようになるはずです。.

これら2行を変更すると、「debug.php」というファイルが/wp-content/に作成されます

以上です…最初のステップが完了しました。これは、開発者が問題の修正プロセスを迅速化するために必要とするファイルの1つです。すべてのエラーは監視され、このテキストファイルに書き込まれます。.

WordPressトラブルシューティングプラグインをインストールする

Health Check & Troubleshootingプラグインは、サイトの通常の訪問者に影響を与えることなく競合チェックを実行できるプラグインです。使い方とインストールはとても簡単で、この例でも引き続き WP Meta SEO を使用します。Health Check & Troubleshootingで競合チェックをインストールして実行するには、次の手順に従ってください:  

• WordPressサイトにログインすると、サイトのダッシュボードが表示されます
• ページの左側にある「プラグイン」をクリックします
• 「新規追加」をクリック
• 以下に示すように、検索バーに「Health Check & Troubleshooting」と入力します

• 「今すぐインストール」をクリックすると、 プラグインの一覧が自動的に読み込まれます。目的のプラグインを探して「今すぐインストール」をクリックし、次に「有効化」をクリックしてください。

• クリックして 「サイトヘルス」、左メニューに 「ツール」 というセクションがあります。それをクリックし、次に 「サイトヘルス」

• 「トラブルシューティング」 タブをクリックし、警告情報を読んで、 「トラブルシューティングモードに入る」 

トラブルシューティングモードは、すべてのプラグインを自動的に無効化し、デフォルトテーマに切り替えます。トラブルシューティングモードは、サイトへの通常の訪問者には影響しません。.  

• 発生していた問題を再現する

デフォルトの環境で有効なプラグインがなく、デフォルトのテーマを使用している場合に問題が発生するなら、それは当社のプラグインが予期しない動作を引き起こしているわけではないことを意味します。

• クリックして 「プラグイン」>「インストール済みプラグイン」

  「プラグイン」メニューが展開され、追加のオプションが表示されます。「インストール済みプラグイン」をクリックしてください

• WP Meta SEO の横にある 「トラブルシューティング中に有効化」 をクリックします WP Meta SEO

• 発生していた問題を再現します 、 WP Meta SEO のみを有効にし、デフォルトテーマを使用した状態で、問題が発生する場合、その問題は当社のプラグインが原因です。

これはある意味で良い知らせです。なぜなら、問題の一部をすでに特定できているからです。次に、開発者があなたのウェブサイトにログインし、新しいバージョンをリリースする前に問題を修正する必要があります！そうでない場合は、エラーを再現できる次の無効化されたプラグインを有効化する手順を繰り返してください。.

WordPress プラグインの JavaScript エラーの確認とデバッグ

Chrome または Firefox のコンソールを使用して JavaScript エラーを探します。ブラウザによって名称は多少異なりますが、Chrome と Firefox に倣って、ここでは「コンソール」と呼びます。コンソールを開くには、次の手順に従ってください:  

• 右クリック して「検証」を選択します。サイトのフロントエンドの任意の部分で行ってください。

• コンソールを選択すると、ページの右側に開発者ツールが開くので、「Console」をクリックします

エラーを確認する、コンソールを開いた状態で、予期していたエラーを再現し、コンソールを確認してください。エラーは赤いテキストで表示され、JavaScriptの競合がどこで発生しているかを示します

JavaScriptエラーが見つかった場合は、 エラーの展開バージョンのスクリーンショットを撮影して チケット/投稿に含めてください。

問題の報告を送信／共有する

この情報がすべて揃ったので、開発者がプロセスを迅速化できるよう支援できます。収集したすべての情報をチケットや投稿に記載してください。項目を思い出しましょう：  

• debug.log
• 競合を引き起こすプラグインに関するメモ
• エラーが表示されたJavaScriptコンソールのキャプチャ

これらの手順に従って正しい情報をお送りいただければ、開発者はより迅速にデバッグ作業を行うことができます。あらかじめご協力に感謝いたします :)    

サポート目的で新しいWordPressユーザーアカウントを作成して共有する

新しい管理者ユーザーを作成することは、サポートチームに問題の内容を伝える簡単な方法の一つです。そのプロセスを始める前に、簡単にご注意ください：

• 問題が解決した後、古い認証情報は保存しません（セキュリティ上の理由から）
• サポート目的で作成された管理者ユーザーアカウントは削除することをお勧めします
• 当チームと共有されたすべての情報は安全に保護され、非公開のままです

新しいユーザーを作成するには、まず管理者サイトにログインします。ログインに成功すると、WordPressのダッシュボードが表示されます。.

次に、左側の メニュー > ユーザーに移動します。

その後、画面上部に移動し、 新規追加 ボタンをクリックするか、左側のメニューの 新規追加 ボタンに移動します。

次に、 新規ユーザーを追加 フォームが画面に表示されます。情報を入力するために必要なフィールドは2つあります： ユーザー名、メールアドレス。

「 パスワード 」フィールドでは、ランダムなパスワードジェネレーターを使用するか、独自のパスワードを設定できます。また、新しいユーザーにアカウントに関するメールを送信したい場合は、 「ユーザーに通知を送信」 オプションにチェックを入れることができます。

その後、ドロップダウンボックスでユーザーの 役割 を選択します。これは、サイト上のユーザーに権限を設定するための重要なステップです。 「管理者」 は最高レベルであり、ユーザーにウェブサイトのすべての機能へのアクセスを許可します。ユーザーのアクセスを制限したい場合は、他の役割を設定できます。

最後に、下部にある 「新規ユーザーを追加」 ボタンをクリックします。これで完了です。頑張ってください！