WordPressプラグインを作ったのでプラグインの申請、審査、公開までの手順などを説明してみる。

今回、Adsense Switchを公開した際に、同じようにプラグインを公開した方たちの記事を参照したりしたのですが、日本語のものは情報が少なく、あっても古いものだったりしたので現在の公開までの一連の流れを書き留めておきたいと思います。

申請に必要なもの

とりあえず、Developer Information – WordPress Pluginsがプラグイン開発者のためのページです。

日本語の情報は、プラグインの作成 – WordPress Codex 日本語版を参照してみてください。

やはり英語のページのほうが情報が多いので困ったら英語のページを見ることになると思います。

申請時に用意するのは以下のものです。

■Wordpress.orgのアカウント

WordPress.orgのアカウントはWordPress.org Loginで作成できます。

このアカウントでプラグインを公開することになります。

■プラグインのプログラムファイル本体
■プラグインに付随するCSSやJSファイル

プラグインのコードのガイドラインは以下のページにあります。

Detailed Plugin Guidelines | Plugin Developer Handbook | WordPress Developer Resources

かなりたくさんあるので、読むのは結構骨が折れると思いますが、きちんとガイドラインに沿ってないと審査と修正で時間が取られるので、ざっと読んでおくべきでしょう。

プラグインのコードの先頭には以下のようなヘッダ情報が必要です。上に紹介した日本語のページに説明が載っていますので、参照してください。

/*
Plugin Name: (プラグインの名前)
Plugin URI: (プラグインの説明と更新を示すページの URI)
Description: (プラグインの短い説明)
Version: (プラグインのバージョン番号。例: 1.0)
Author: (プラグイン作者の名前)
Author URI: (プラグイン作者の URI)
License: (ライセンス名の「スラッグ」 例: GPL2)
*/

■readme.txt

readme.txtは私は↓のジェネレータを使用して作り、出来上がったものを元に文章をいくつか修正して作りました。

Generate WordPress Plugin readme.txt file

ちょっと分かりにくいですが、Plugin Versions…というところがタブになっていて、それぞれの情報を記入していくようになっています。

分からない箇所があったら他のプラグインのreadmeを参考にしてみるといいでしょう。

記入し終わったらUpdate Codeボタンを押すと生成されたreadme.txtをダウンロードできます。

出来上がったファイルは以下のバリデーターで問題が無いかチェックしておきましょう。

Readme Validator — WordPress Plugins

いざ申請

用意したプログラムと付随ファイル、readme.txtをzipで一つのファイルにして以下のページからアップロードします。

Add your Plugin – WordPress Plugins

審査にはコードの複雑さに応じて、1日から10日程度かかると書かれています。

私のプラグインはかなり小さいものなので、アップロードした次の日には返事が来ました。

上のほうで、「プラグイン開発のガイドラインを読んでおきましょう」と書きましたが、実は私は全然読まずに申請しました。

そのため、2回ほど審査でダメ出しを食らいました。チェックしてくれたスタッフの人には申し訳ないです。反省・・・

ちなみに私が指摘されたのは、入出力のバリデーションが不完全だということと、functionの名前の一つにプリフィックスが付いていない(他のプラグインなどのfunction名と衝突するのを防ぐために必要)ということでした。

私が会社でプラグインを開発していた時は、社内だけで使用するのが目的で、公開する必要はなかったのである程度バリデーションが不十分でも動けば良かったのですが(本当は良くないのですが 😛 )、さすがに公開するとなると色々と厳しいなと実感しました。

でも、Wordpressとしても質の低いプラグインを公開させるわけにはいかないでしょうから、厳しい理由はよく分かります。

プラグインのアイコンやスクリーンショットを用意する

審査を待っている間にプラグインのアイコンなどを用意しておきましょう。もちろん、無くても問題ありませんがやはりあったほうが見た目がいいですからね。

詳細については以下のページで説明されています。

How Your Plugin Assets Work | Plugin Developer Handbook | WordPress Developer Resources

私はプラグインのヘッダ画像は面倒なので無しにしました。

アイコンは適当にフリー素材から拾ってきました。

アイコンの大きさは以下の通りで、名前の付け方が決まっていますのでその通りに名前を付けます。

  • Normal: icon-128×128.(png|jpg)
  • High-DPI (Retina): icon-256×256.(png|jpg)

スクリーンショットはプラグインのページに表示されるものです。ファイル名は以下のように付けていきます。

  • screenshot-1.(png|jpg)
  • screenshot-2.(png|jpg)

そして、readme.txtの”== Screenshots ==”の欄にそれぞれの画像の説明を書いておくと、上のスクリーンショット画像と一緒に表示されるようになります。

私の場合は以下のようにしました。

== Screenshots ==
1. Plugin general settings
2. Individual page/post setting

プラグインを公開する

晴れて審査にパスするとSVNのURLが送られてきます。

このURLにプラグインをアップロードするとプラグインがリストに公開され、検索ができるようになります。

コマンドラインでやる方法が良く出ていますが、私は使い慣れているTortoiseSVNを使いました。

Tortoiseを使っている人に改めて説明する必要は無いと思いますが、初めて使う人のために少しだけ手順を書いておきます。

1.Tortoiseをインストール後、プラグインを管理するための適当なフォルダを作ります。そのフォルダを右クリックし、メニューの中からTortoiseSVN→Repo-Browserを選択し、出てきたウィンドウのURLのフィールドにWordpressから送られてきたSVNのURLを入力します。

2.URLの構成は以下のようになっています。

再度フォルダを右クリックし、メニューの中からSVN Checkoutをクリックすると以下のようなフォルダがダウンロードされます。

3.基本的には、trunkフォルダにプラグインのコードとreadme.txtを入れ、assetsフォルダに用意しておいたアイコンやバナー、スクリーンショットの画像を入れます。

その他のフォルダの用途などはUsing Subversion | Plugin Developer Handbook | WordPress Developer Resourcesを参照してください。

4.ファイルを全て置き終わったら、プラグインのルートフォルダで右クリックをし、TortoiseSVN→Addを選択します。そうすると、追加したファイルがリスト表示されるので、間違いが無いのを確認してOKを押します。以下はテストのために新規テキストファイルを作ってAddしようとしているところです。

5.Addしたら、次はいよいよコミットしてサーバーにアップロードします。再度フォルダを右クリックし、SVN Commitを選択します。Wordpressではコメントを入力しないとコミットできないので、必ず何かコメントを入力します。一番最初はInitial versionとでも入れておけばいいでしょう。次回からは変更内容を入力します。
それぞれのファイルのチェックボックスにチェックが入っているものがコミットされますので、チェックが入っているか確認したらOKボタンを押してコミットします。コミット時にIDとパスワードを聞かれるので自分のWordpressのアカウントを使います。

以上で公開は完了です。数分くらいしてから自分のプラグインページを開いてみましょう。プラグインのアドレスは、

https://wordpress.org/plugins/プラグインのスラッグ

というような感じになります。また、プラグイン名を検索して表示されるかも確認してみてもいいでしょう。

私はプラグインのページを確認しながら、文章などの細かい修正を行いました。

以上でプラグインの公開は完了です。お疲れ様でした。

ABOUT ME
かわずん
かわずん
アンチ・ブラック企業ブロガー