ここではWindowsユーザーを想定して、SubversionクライアントであるTortoiseSVNを使用しています。その他のOSをご使用の方は、How to Use Subversionをご参考にsvnをご利用ください。

WordPressのプラグインを作成したら、ぜひ登録してみたいのがWordPress.orgのプラグインディレクトリだ。WordPress.orgのプラグインディレクトリは、ユーザーが作成したWordPressの機能を拡張するプラグインをホスティングして公開してくれるオフィシャルのディレクトリだ。このプラグインディレクトリに登録することで多くの人の目に留まることはもちろん、ダウンロード回数を記録してくれたり、コメントを残せたり、評価付けされたりするので、プラグインを自作したなら登録しないともったいない。この記事では、自作のプラグインをWordPress.orgのプラグインディレクトリに登録する方法を順を追って説明していきたいと思う。

プラグインディレクトリの規則

まず、WordPressのプラグインディレクトリには若干の制限がある。Plugin DirectoryのDeveloper Centerの説明には次のようにある。まぁ、特に問題はないと思う。

  • プラグインのライセンスがGPLに準拠していること。
  • 法を犯したり、道義に反したことはしないこと。
  • subversionを使う必要があること。(WordPressのプラグインディレクトリはホスティングサイトでリスティングサイトではない)

1.WordPress.orgのアカウントを取得する

WordPress.orgのアカウントは無料で取得できる。アカウントを取れば、サポートフォーラムへの書き込みもできたりする。アカウントの取得はこちらから。(プラグインディレクトリの方からもできる。アカウントとしてはどっちでも一緒だと思う。)とりあえず必須項目のUsernameとEmailを入力するだけでいい。Usernameは後から変更できなさそうなので少し注意が必要か。登録後、パスワードがメールで送られてくる。(ちなみにアカウント設定およびパスワードの変更などは、フォーラムの右上のView your profileを見れば編集できる。)

WordPress アカウント登録

2.プラグインの登録申請を出す

アカウントを取得後ログインして、Add Your Pluginを開く。入力項目は3つで、Plugin Name(プラグイン名)とPlugin Description(プラグインの説明)は必須、Plugin URL(プラグインのURL)はオプションだ。プラグイン名はすでに存在するプラグインと名前が重複しないようにしたほうがいいだろう。また、プラグインのURLはできればあった方がいいんじゃないかと思うが分からない。送信後、このページに送信した日付と、送信内容が表示されるので確認しよう。これはプラグインのリクエストが受理されると消える。

WordPress プラグインの登録申請

3.プラグインの承認メールを待つ

問題がなければ、プラグインの登録申請から大体一週間前後で承認メールが送られてくる。このメールにはSVN (Subversion)のリポジトリのアドレスが書かれている。このリポジトリにアクセスするには、WordPress.orgのアカウントのUsernameとPasswordが必要になってくる。

4.TortoiseSVNをインストールする(Windowsユーザー向け)

Subversionの使い方についてはWordPressのプラグインディレクトリのHow to Use Subversionでも解説されているが、Windowsを使用しているのでフリーのSubversionクライアントであるTortoiseSVNを使いたい。TortoiseSVNのダウンロードはこちらから行う。日本語パックも同じページにあるのでダウンロードしよう。TortoiseSVNのインストールは簡単で、インストーラーに従うだけでいい。TortoiseSVNのインストールが済んだら、日本語パックもインストールしておく。日本語化はTortoiseSVNの設定で変更。(TortoiseSVNの詳しいインストールはこちらを参照

TortoiseSVNのインストール

5.ディレクトリを作成する

リポジトリをチェックアウトするために適当にディレクトリを作成する。ここでは分かりやすくプラグインの名前でディレクトリを作成した。作成場所はデスクトップでもどこでもかまわないだろう。

ディレクトリを作成

6.SVNのチェックアウト

先ほど作成したディレクトリの上で右クリックをして、SVNチェックアウトをクリックするとダイアログボックスが表示される。

SVNチェックアウト

一番上のリポジトリのURLに承認メールで送られてきたURLを入力する。チェックアウトディレクトリはすでに入力されているはずだ。これらの入力を終えたらOKをクリックする。チェックアウトが終了すると、branches、tags、trunkというフォルダが追加されているはずだ。全部中身は空。(正確には.svnというフォルダが隠しフォルダで存在する。)

SVNチェックアウト リポジトリのURL

7.プラグインとReadmeファイルの準備

WordPressのプラグインディレクトリに掲載される内容はプラグインに含まれるreadme.txtの内容に由来する。そのため、WordPressのプラグインディレクトリのガイドラインに従う必要がある。サンプルのreadme.txtはこちらから見ることができる。とりあえず、サンプルを真似て作成すればいいだろう。その他、気になる点としては以下。

  • Readme.txtに書くTagsはWordPressのプラグインディレクトリのタグクラウドを参考にする。
  • バージョンは1.0a1とかにせずに、1.0.1のようにシンプルにした方がいいみたい。
  • スクリーンショットがある場合はscreenshot-1.png、screenshot-2.png、screenshot-n.pngのようにする。

また、WordPress/BBPress Plugin readme.txt Validatorというのも用意されているので、作成したreadme.txtで問題ないか確認することができる。バリデーションに合格すると以下のようなメッセージが出てくる。

Your readme.txt rocks. Seriously. Flying colors.

8.プラグインファイルをtrunkにコピーする

先ほどチェックアウトしてできたtrunkフォルダにプラグインのファイルをコピーする。メインのプラグインファイルとreadme.txtは必ずtrunk直下にコピーしてほしい。

プラグインファイル

9.リポジトリにコミットする

trunkフォルダを右クリックして、SVNコミットを選択する。

SVNコミット

下記のようなダイアログボックスが表示されるのでメッセージ欄に適当に「Adding first version of my plugin」のように入れ、リポジトリにコミットするファイルを選択する。Windowsの場合、画像ファイルがあるとThumbs.dbのようなゴミがあるのでそれは含まないようにしたい。最後にOKを押す。UsernameとPasswordを入力するように求められるので、WordPress.orgで取得したアカウントのUsernameとPasswordを入力しよう。うまくいけばコミットしている内容が表示されるはずだ。

SVNコミット ダイアログボックス

10.プラグインのリリースをタグ付けする

readme.txtでStable tagのバージョンを設定したと思うが、このStable tagと同じバージョンをリポジトリのtagsに追加する。trunkフォルダを右クリックし、TortoiseSVNのブランチ/タグを選択する。

ブランチ/タグ

先 URLのtrunkを消して、下記のようにtags/0.1.1のように変更。ログメッセージに「Tagging version 0.1.1」のような感じで入力してOKを押す。正常に終了したら、tagsフォルダを右クリックして、SVN 更新を選択しよう。先ほど追加したバージョンのフォルダが作成されれば完了だ。

ブランチ/タグ

11.確認する

以上でWordPress.orgのプラグインディレクトリにプラグインを登録する流れは終了である。きちんとプラグインディレクトリに自分のプラグインが登録されたか確認してみよう。コミットしてからプラグインディレクトリに反映されるまでにはタイムラグがある(数十分程度)ので気長に待とう。プラグインディレクトリから自分のプラグインのページを開き、readme.txtがきちんと反映されているか確認したい。もしおかしなところがあったら、修正・コミットを繰り返す。また、新しく登録されたプラグインはWordPress.orgのプラグインディレクトリの右側にあるNewest Pluginsに表示されるので見てみるといい。

まとめ

以前、Lightbox Gallery Pluginを作成した際に、色々と調べてWordPress.orgのプラグインディレクトリに登録してみたわけだが、多少分かりにくいところもあった。最近、カスタムフィールドの入力を支援するCustom Field Templateというプラグインを作成したが、いい機会なのでこのプラグインディレクトリに登録する方法をまとめておこうと思ったわけだ。せっかくプラグインを作成したので多くの人に使ってもらえた方がうれしいわけで、このWordPress.orgのプラグインディレクトリに自作プラグインを登録する方法を読んで、今後プラグインを作成・公開したいと思う人が出てくる一助になれば幸いだ。

プラグインディレクトリ登録で参考にしたサイト

関連する記事

12 Comments

  1. Pingback: WordPress.orgのプラグインディレクトリに自作プラグインを登録する方法 | WordPressで企業ウェブサイト作成・商用ホームページ制作 WordPress Go Go | PHP RSS JavaScript メモ

  2. Pingback: あり » Blog Archive » WordPressプラグインの作成(4)

  3. Pingback: 拙作プラグインをプラグインディレクトリにて公開開始 – [Mu]ムジログ

  4. Pingback: WordPress プラグインを公開する手順 | NINXIT-BLOG

  5. Pingback: ホームページ制作のディークラフト » wordpress.orgのプラグインディレクトリに自作のプラグインを登録

  6. Pingback: WordPress プラグインディレクトリに公開した  :  かばだんなさん かく語りぬ2

  7. Pingback: プラグインを WordPress.org に公開 - Doluck!

  8. Pingback: 公式ディレクトリにプラグインをアップしました « 12net.jp

  9. Pingback: 【wordpressのプラグインを自作しました】作成したついでにwordpress.orgにも登録しました | 今村だけがよくわかるブログ

  10. Pingback: WordPressのプラグインを作成して公式ディレクトリに登録して公開する時に参考になるサイトやスライドまとめ – WebCake – ウェブケイク

  11. Pingback: WordPressとわたし | tz_blog

Comments are closed.