管理画面環境識別プラグイン for EC-CUBE 4.0系

管理画面環境識別プラグインは、EC-CUBEの管理画面で、現在操作している環境を分かりやすく表示するためのプラグインです。

本番環境、検証環境、ステージング環境、ローカル環境などを見分けやすくできます。
環境の取り違えによる誤操作を減らしたい場合に役立ちます。

このプラグインでできること

管理画面のヘッダー色を変更できます。
ヘッダー色変更はON/OFFを切り替えられます。
色はプリセット色から選択できます。
また、#00aaffのような6桁の16進数RGBカラーコードで、任意の色を指定することもできます。

ショップ名の後ろに短い文字列を追加できます。
追加文字列の表示もON/OFFを切り替えられます。
文字列は20文字以内で設定できます。
たとえば「STG」「TEST」「LOCAL」などを表示することで、環境名をすぐに確認できます。

解決できる課題

複数の環境を運用していると、どの管理画面を操作しているのか分かりにくくなることがあります。
特に、本番環境と検証環境を同時に開いて作業する場合は注意が必要です。
見た目が同じ管理画面では、作業対象を取り違えるリスクがあります。

このプラグインを利用すると、ヘッダー色や表示文字列で環境を見分けやすくなります。
作業前の確認がしやすくなり、誤操作の防止につながります。

メリット

管理画面を開いたときに、作業中の環境を直感的に確認できます。
本番環境は赤、検証環境は青、ローカル環境は緑のように色分けして運用できます。
色だけでなく文字列も表示できるため、より確実に環境を判別できます。

作業者が複数いる場合でも、環境の見落としを減らせます。
リリース前の確認作業や、日々の運用作業を安心して進めやすくなります。
環境確認の負担を減らし、管理画面での作業ミスを防ぐ助けになります。

利用シーン

本番環境と検証環境を分けて運用している店舗に向いています。
制作会社や開発担当者が、複数のEC-CUBE環境を管理している場合にも便利です。
リリース前の動作確認や、ステージング環境での検証作業にも活用できます。

たとえば、検証環境には「TEST」、ステージング環境には「STG」、ローカル環境には「LOCAL」と表示できます。
環境ごとにヘッダー色を変えることで、ひと目で違いが分かります。

設定方法

設定は、管理画面の「設定」配下に追加される「管理画面環境識別設定」から行います。
設定を保存すると、管理画面の各ページにヘッダー色や追加文字列が反映されます。
ショップ名リンクの遷移先や別タブ表示の挙動は、EC-CUBE標準のまま維持されます。

運用時の注意事項

ヘッダー色変更がOFFの場合は、EC-CUBE標準のヘッダー色が表示されます。
カスタム色を指定する場合は、#から始まる6桁の16進数RGBカラーコードで入力してください。
追加表示文字列は20文字以内です。
前後の空白は保存時に削除されます。

HTMLタグの入力は許可されません。
表示時はTwigの自動エスケープが利用されます。
設定が反映されない場合は、設定がONになっているか確認してください。
プラグインが有効化されているかも確認してください。
必要に応じて、EC-CUBEのキャッシュをクリアしてください。

EC-CUBE4.0に対応した管理画面環境識別プラグイン ver1.0.0 をリリースしました。
管理画面のヘッダー色変更や、ショップ名の後ろに短い文字列を追加することで、ローカル、ステージング、検証、本番などの環境を判別しやすくできます。
作業対象の環境を視覚的に確認しやすくし、日々の運用や確認作業における誤操作リスクの軽減に役立ちます。