【初めての方向け】EC-CUBEプラグインの作り方と、オーナーズストアへの掲載方法まとめ

[456 views]

20181205

EC-CUBE Advent Calendar 2018 20日目の記事です。

「EC-CUBE 3」からのメジャーバージョンアップ版である「EC-CUBE 4」が10月11日にリリースされ、「EC-CUBE 4」に対応した様々なプラグインも日々お寄せいただいております。

今回は、初めての方向けに、EC-CUBE 4に対応したプラグインの作り方や、EC-CUBEのショップオーナー向けのサービスサイト「オーナーズストア」への掲載方法についてまとめさせていただきます。

EC-CUBEプラグインとは?

EC-CUBEのプラグインは、EC-CUBE本体にインストールするだけで、カスタマイズやサービス連携の機能を簡単に追加できる仕組みです。外部サービスとの繋ぎ込みプラグインや、EC-CUBE本体をカスタマイズするプラグインなど、あらゆる機能をプラグインとして提供していただくことができます。

サイトごとに個別の開発をすることなく、簡単に機能を追加できることから、EC-CUBEのサイトを構築する方にとって、EC-CUBEのプラグインは欠かせないものとなっています。また、プラグインを作ってみたい方にとっても、プラグイン単体の機能開発のみで動作し、EC-CUBEの本体に手を加える必要がないため、手軽に始めることができます。

EC-CUBEプラグインの作り方

(1)開発環境の準備

プラグインの開発をするには、まずは、EC-CUBE本体をインストールした開発環境を準備し、サンプルプラグインをインストールしてみましょう。

インストール方法、開発ガイドラインや要素技術の概念、本体開発やプラグイン開発のチュートリアル、Cookbookなどの情報を提供しているEC-CUBE 4.0 開発ドキュメントサイトの、以下メニューを参考に進めます。

「EC-CUBE 4」本体のシステム要件
「EC-CUBE 4」本体インストール方法
サンプルプラグインのインストール
プラグインの仕様について
プラグインサンプル

※デザイン周りは以下資料もございますので、こちらも参考にしてください。

EC-CUBE 4 管理画面デザインガイド
スタイルガイド
フロント画面テンプレート for Adobe XD(zipファイル)

(2)開発スタート

サンプルプラグインのソースや開発ドキュメントサイトを見ながら、実際に、作りたいプラグインを開発します。
開発中の相談については、開発コミュニティや、slackの#pluginチャンネル、及び、東京ユーザーグループ名古屋ユーザーグループ関西ユーザーグループ九州ユーザーグループなどのコミュニティの勉強会で情報交換することもご検討ください。

(3)アイコン・紹介テキストの準備

無事にプラグインを開発されたら、プラグインを申請する前に、プラグインの顔となる「アイコン」や、どのような機能のプラグインなのか説明するための「紹介テキスト」もご確認ください。

プラグインの説明文については、実際にオーナーズストアに掲載されているプラグインを参考にしてください(例:関連商品プラグイン)。

アイコンについては、以下のガイドラインもご用意しています。

アイコン作成のガイドライン

(4)オーナーズストアへの掲載

プラグインやアイコン・説明文のご用意ができたら、いよいよオーナーズストアへの掲載に進みます。
以下、3stepとなります。

Step1 EC-CUBEパートナー登録

プラグインの登録には、EC-CUBEパートナー(無料)の登録が必要ですので、以下よりご登録ください。

EC-CUBEパートナー登録

Step2 パートナー管理ページ内でプラグインを登録

アカウント取得後、パートナー管理ページにログインし、プラグインを申請してください。
(パートナ管理ページログイン>ストア管理>プラグイン管理)

パートナーページ:プラグイン管理
プラグイン申請マニュアル

Step3 オーナーズストアに掲載開始

おつかれさまでした!
登録申請後、EC-CUBE運営チームの審査を経て、オーナーズストアに掲載開始されます。

最後に

いかがでしたでしょうか?

プラグインのオーナーズストア上での公開は、EC-CUBEを使ったカスタマイズを得意とされる制作会社の方々の技術力のアピールとなるのはもちろんのこと、プライベートでのご自身のスキルを磨くツールとして活用されている方もいらっしゃいます。

公開されたプラグインは、オーナーズストアでの公開の他、EC-CUBE公式のTwitterFacebookメールマガジンでもご紹介してまいります。

尚、ご自身が開発者ではないが、作ってほしいプラグインのアイデアがあるという方は、Twitterで #eccube #プラグインウィッシュリスト タグをつけて投稿ください。プラグイン開発者の方へ、皆様の声をお届けします!


このEC記事につけられたタグ