プラグインを作成した後、それを配布しようとする場合、2つ方法があります。
1.自分のサイトで配布する方法
2.WordPressのプラグインディレクトリに登録
ここで、プラグインをWordPress Plugin Directoryに登録するため必要なことを個人的なメモも兼ねてピックアップします。
プラグインのファイルについて
ライセンス情報について
個人で使用する場合ライセンス情報を書かないで使用するのですが、プラグインディレクトリ(Plugin Directory)に登録する際には、ライセンス情報を記述する必要があります。
そのライセンス情報の書く内容の参考ページがプラグインの作成にあります。
このライセンス情報を主要ファイルに記述します。
ライセンスはGPL2、または互換ライセンスということです。
説明ページの作成
プラグインと一緒にreadme.txtファイルを作成する必要があります。
そのreadme.txtファイルの書く内容のサンプルページがあります。
readme.txtに書いた内容が、プラグインのページに表示されますので、丁寧に詳しく書けるなら書いたほうが良いんですが、必要事項(基本情報、Description、Installation)を書くだけでも大丈夫です。
また、自分のサイトにプラグインの機能や使い方の説明を書き、リンクからアップデート情報やヘルプ情報にチェックできるようしておくと良いらしいです。
プラグインの申請
プラグインの申請にあたり準備すること
1.プラグインの作成とライセンス情報の記述
2.プラグインのダウンロードできるファイルの用意
3.readme.txtファイルの作成
申請・登録
Add Your Pluginページの下にある「log in」のリンクよりログインをします。
※まだ登録していないとき、日本語サイトからも登録できます。
ログインして「Add Your Plugin」で必要事項を書いて提出します。
Plugin Nameにはプラグインの名前を入力します。
Plugin Descriptionには、プラグインの説明を書きます。
説明の書く文は、例えばreadme.txtのDescriptionの内容で大丈夫です。
Plugin URLは、プラグインを公開するページはここですという意味ではなく、プラグインをダウンロードできるサイト(またソースコードファイルを入手できるようなサイト)を用意して、そのページのURLを記載します。
プラグインファイルを審査する人がアクセスできるようにするには下の方法があります。
- subversionにファイルをアップロード(コミット)する
- 自分のサイトにダウンロードできるようにzipファイルを用意する
私の体験ですと、Plugin URLに書いたページにファイルを用意していなかったので、申請後に再度プラグインを公開しているURL、またプラグインを圧縮したzipファイルを添付ファイルにして返信してください、ということで両方記載して再提出することになり手間が掛かりました。
審査の通知
プラグインの申請をしたあと、数日以内メールで審査の通知があります。
通った場合は、プラグインを指定のURLにアップロード(コミット)します。
不備などで通らなかった場合は、メールに書かれている方法により再度審査してもらうための準備して審査してもらいます。
審査が通って、プラグインを指定のURLにアップロード(コミット)すると、ファイルのバージョンなどの書き間違えがなければ、私の体感ですと、すぐにダウンロードできるように公開されます。
※ファイルのコミット(アップロード)
前に書いた記事に、プラグインファイルを指定のURLにコミット(アップロード)して公開するためのアプリケーションの利用方法について書いてあるので参考にして下さい。
TortoiseSVNのインストールと日本語化の方法
TortoiseSVNでプラグインファイルをアップロードする方法
コメント