【EC-CUBE3】プラグインアップロードエラー：config.yml not found or syntax errorの解決方法

EC-CUBE3を使ってECサイトを構築する際、多くの方が利用する「プラグイン」の機能。しかし、その便利なプラグインをアップロードする時にプラグインアップロードエラー「config.yml not found or syntax error」というエラーメッセージに直面することがあります。これは、特にECサイト運営においては解決したい問題の一つです。
そこで、この記事では、そのエラーメッセージの原因と解決方法を分かりやすく解説します。
結果、簡単に解決できました。

エラーメッセージ「config.yml not found or syntax error」の原因

EC-CUBEの管理画面より、「オーナーズストア」→「プラグイン」→「プラグイン一覧」で圧縮（zip）ファイルをアップロードすると、「config.yml not found or syntax error」というエラーが出ました。
「config.yml」ファイルの記述が悪いのかと内容を確認して、何度か試してみたのですがエラーは解消されませんでした。

「config.yml not found or syntax error」というエラーメッセージが表示される主な原因ですが、これはプラグインをアップロードする際のファイル構成に問題があることが原因です。具体的には、プラグインフォルダ全体を圧縮してアップロードしてしまうことで、EC-CUBE3が必要とする「config.yml」ファイルを正しく認識できずにエラーが発生します。

【EC-CUBE3】プラグインアップロードエラーの原因と解決方法

この問題を解決する方法は非常にシンプルです。プラグインフォルダ内のファイル構成を正しく圧縮することで、エラーなくプラグインをアップロードできます。

アップロードエラーの原因

原因は「config.yml」やphpファイル等諸々入っている1フォルダ自体を圧縮してアップロードしていることが原因でした。

（sampleプラグインフォルダ例）
sample ← ※1:このフォルダを圧縮してはダメ
│
│　↓※2:この階層に移動し、配下のファイルとディレクトリをまとめて圧縮
│
│ config.yml
│ aaa.phpp
│ bbb.php
├─ccc
└─ddd

アップロードエラーの解決方法

※1:このフォルダ（sample）自体を圧縮してアップロードするとエラーになりました。アップロード後にフォルダ階層が1つ下がって「config.yml」が見つからないエラーになります。
※2:圧縮するフォルダ（sample）内の階層に移動し、その場所にあるファイルやフォルダ等を1つのファイルにまとめて圧縮します。

「※2」の方法で圧縮したzipファイルを管理画面の「プラグイン一覧」からアップロードすると、無事アップロード（インストール）できました。

　
このシンプルながらも重要なポイントを理解し、実践することで、「config.yml not found or syntax error」というエラーメッセージに悩まされることなく、スムーズにプラグインのアップロードとインストールを行うことができます。

まとめ

EC-CUBE3でのプラグインアップロード時に「config.yml not found or syntax error」というエラーに直面した場合は、圧縮するファイルの構成を見直してください。正しいファイル構成で圧縮し直すことで、この問題は簡単に解決します。この記事が、EC-CUBE3を利用してECサイトを運営する皆さんの一助となれば幸いです。

この記事では基本的な解決策を紹介しましたが、EC-CUBE3の使用において他にも様々なチャレンジがあるかと思います。プラグインのカスタマイズ、テーマの変更、セキュリティの強化など、EC-CUBE3を使いこなすためには絶えず学び、試行錯誤することが重要です。このような情報交換の場を提供し続けることで、より良いECサイト運営の実現に貢献していきたいと思います。

　
※流用・参考にされる場合は自己責任でお願いします。