プラグインを開発する
プラグインの基本的な開発手順について解説します。
前提条件
- EC-CUBEをローカル環境にインストールしていること
- PHPがコマンドラインで実行できること
プラグインの雛形を生成
bin/console eccube:plugin:generate コマンドでプラグインの雛形を生成できます。
bin/console eccube:plugin:generate
EC-CUBE Plugin Generator Interactive Wizard
===========================================
name [EC-CUBE Sample Plugin]:
> <プラグイン名を入力して Enter>
code [Sample]:
> <プラグインコードを入力してEnter>
ver [1.0.0]:
> <バージョン番号を入力してEnter>
[OK] Plugin was successfully created: EC-CUBE Sample Plugin Sample 1.0.0
上記で app/Plugin/Sample というプラグインの雛形が生成されます。
プラグインをインストール
bin/console eccube:plugin:install --code=<プラグインコード> でインストールできます。
bin/console eccube:plugin:install --code Sample
Run bin/console cache:clear --no-warmup...
// Clearing the cache for the dev environment with debug
// true
[OK] Cache for the "dev" environment (debug=true) was successfully cleared.
[OK] Installed.
インストールが完了すると、EC-CUBE管理画面→オーナーズストア→プラグイン→プラグイン一覧にて確認できます。
その他、開発時に利用可能なコマンドはこちらをご確認ください。
プラグインを開発する
app/Plugin/<プラグインコード> のファイルを修正し、開発してください。
プラグインを削除すると、app/Plugin/<プラグインコード> 配下のファイルも物理的に削除されますのでご注意ください。
その他
プラグインのプログラムを Git でバージョン管理したい場合は、以下の記事を参考にしてください。
Composerを使いこなしてEC-CUBE4系プラグインの開発効率を爆上げする
プラグインの E2E テストをしたい場合は、以下の記事を参考にしてください。
オーナーズストアへ登録するプラグインのテストをしたい場合は、次のページをご確認ください。