プラグインのトラブル対処法
どんな時に発生するのか?
- プラグインをインストールした途端エラーが発生し、フロントや管理画面にアクセスできなくなる
- プラグインを有効化する際にエラーが発生し、フロントや管理画面にアクセスできなくなる
- プラグインのインストールや更新や有効化には成功したが、なんだか表示がおかしくなった
このページではこれらの事象の解決策について記載いたします。
メンテナンスモード下でのインストール
前提として、プラグインをインストールする際はメンテナンスモードにしてから実行すると、キャッシュ関連の問題が起きにくくなります。
EC-CUBEの管理画面へアクセスし、「コンテンツ管理」の「メンテナンス管理」からメンテナンスモードを有効にした後プラグインのインストールをおこなってください。
インストールや有効化時にエラー発生、サイトアクセス不可となった場合
まずは以下をご確認ください。
- ec-cube.co環境である -> イーシーキューブ社サポートへお問い合わせ
- サーバーへ入り、コマンド実行などを行うのが困難である -> よくあるご質問 - モジュールやプラグイン設置後のエラーへ
- 上記以外の場合、以降をお読みいただきご確認や実行を行ってみてください。
壊れたキャッシュが残ってしまった
もっとも多いエラーの原因として、インストールプロセスの途中終了により壊れたキャッシュが残ってしまうことがあります。 以下の手順でキャッシュをクリアし、再度インストールをお試しください。
管理画面のメニュー追加が行われた際にNavファイルだけ有効化されてしまった
管理画面のメニュー追加を行うプラグインの場合、プラグインの有効化時にまれに起こることがあります。
有効化が正常に終了せず、Navファイルec-cube/app/config/eccube/packages/eccube_nav.yaml
のみ有効化されルーティングが有効化されない状態です。
以下の手順を試してみてください。
- Navファイルをローカルにバックアップします。
- サーバー上のNavファイルを削除します。
- 管理画面にログイン出来るようになります。
- 管理画面より、プラグインを一旦無効化します。
- ローカルにバックアップしたNavファイルをサーバーの元のディレクトリへ戻します。
- 管理画面から有効化を行うと再度エラーとなる可能性も有るため、可能であればコマンドでのプラグイン有効化をおすすめします。
プラグインが競合してしまった
プラグインを複数インストールし競合してしまった場合は、プラグイン製作者へ相談しましょう。
その際、エラーログ・再現方法などの情報を準備しておくとやりとりがスムーズになります。
上記の対処法でも解決しない場合
その他の対処法や原因・予防対策について、EC-CUBEエバンジェリスト大河内氏の以下の記事にて詳しくご紹介されております。ぜひご参照ください。
有効化したが表示がおかしい場合
以下の事象が想定されます。
また、表示くずれなどは有効化のみならずプラグインを更新した際にも発生することがあるようです。
- 有効化には成功したが、管理画面に追加したプラグインのメニューや設定アイコンなどが表示されない
- 有効化には成功したが、表示がくずれる、または英語表記や文字化けが起こる
有効化したが管理画面のメニューや設定アイコンなどが表示されない
一度プラグインを無効化していただき、再度有効化してみてください。
有効化したが表示がくずれる、または英語表記や文字化けが起こる
管理画面よりキャッシュをクリアしてみてください。
上記の対処法でも解決しない場合
プラグイン製作者へ相談しましょう。
付録:キャッシュをクリアする方法
管理画面でキャッシュクリア
管理画面へのログインが可能な場合、
管理画面の [コンテンツ管理] > [キャッシュ管理] からキャッシュクリアをお試しください。
コマンドでキャッシュクリア
管理画面へアクセスできない場合は、コマンドラインからキャッシュをクリア&生成する方法をお試しください。
前提として、コマンドラインの操作のためにターミナルからSSH接続が必要となります。
ご契約サーバーのSSH接続方法をご確認ください。
SSH接続後、EC-CUBEのディレクトリへ移動します。
## path/to/eccube_rootの部分にEC-CUBEのディレクトリパスを記載
cd path/to/eccube_root/
キャッシュのクリアと生成コマンドを実行
## Symfony コマンドでのキャッシュクリアと生成
bin/console cache:clear --no-warmup
bin/console cache:warmup
※キャッシュクリアコマンドがうまくいかない場合は、強制削除をお試しください。
## path/to/eccube_root/の部分はEC-CUBEのディレクトリパスを記載
rm -rf path/to/eccube_root/var/cache/*
ディレクトリのキャッシュを削除
コマンドでキャッシュクリアがうまくいかない場合は、ディレクトリのファイルを削除する方法をお試しください。
- FTP接続する
- EC-CUBEディレクトリ内の
var/cache/
以下のディレクトリを削除する