WordPress.orgへプラグインの公開の仕方

メモ
Page content

自分用もあって忘れないために WordPress.org へプラグインの公開の仕方をメモ。プラグインの作り方ではなく公開の仕方限定。

必要な知識

  • PHP - WordPress 自体が PHP なのでこれは必須
  • WordPress - WordPress のプラグインを書くためには WordPress の内部構造などを知っていないと難しい
  • Subversion - WordPress.org は各種プラグインを SVN で管理している

プラグイン作った。次は？

  1. WordPress.org のアカウントを持っていなければ取得
  2. [WordPress › Requests](http://wordpress.org/extend/plugins/add/) にて、プラグインの名前と説明と任意でプラグインのアドレスを書いてリクエスト送信
  3. リクエストが承認されると Subversion のアドレスが送られてくるので、そのリポジトリにプラグインをインポート
  4. 適切な readme.txt を作り、プラグインの本体ファイルに適切なコメントをつける（後述）
  5. リリースバーションごとに readme.txt などを編集し、SVN のタグ付けをする（後述）
  6. WordPress.org が15分毎に巡回してくれて、正しくコメントが付けられていればプラグインディレクトリーに掲載される

readme.txt とコメントとは？

WordPress.org はプラグインの更新のチェックに trunk/readme.txt と本体ファイルのコメントを使用する。 readme.txt は書式が決まっていて、readme.txt の例を参照。WordPress/BBPress Plugin readme.txt Validator を使用すればバリデートできる。 本体ファイルのコメントは、PHPファイルの先頭に次のようなコメントを書く。

/*
Plugin Name: Example Plugin
Plugin URI: http://example.com/foo
Description: This plugin is an example.
Version: 1.0
Author: Bar
Author URI: http://example.com
*/

他のプラグインを参考にすれば大体OK。

プラグインをリリースしたい

プラグインのリリースは SVN のタグ付けを使う。 readme.txt と 本体ファイルのコメントのそれぞれ Stable tag と Version の項目をリリースするバージョンにあわせる。 必要なファイルを編集したら SVN でタグ付け。タグ名は数字とピリオドのみを使ったほうが良いと公式のドキュメントには書いてある（1.2.3はOK、ver1.2RC1などはNG← 実際は可能）。 あとは巡回で更新が認識されればプラグインディレクトリーに載る。

参考になるドキュメント

  • [WordPress › WordPress Plugins](http://wordpress.org/extend/plugins/about/) 以下のドキュメント