Developer

WordPress 公式ディレクトリデベロッパー用のドキュメントです。

Publish Official Plugin

WordPress の公式プラグインディレクトリに自作のプラグインを載せるには申請と審査が必要で、問題がなければ 1 週間以内に公開可能です。公式ディレクトリは Subversion(略称:SVN)という古くからある Git 似のシステムでバージョン管理されており、コマンドで操作して申請する方法がもっとも手軽です。

1. Create plugin

まずは公式プラグインとして形式を整えます。必須ファイルは以下の 2 つです。

  • readme.txt:公式ディレクトリで扱う情報を記載
  • [your-plugin-name].php:プラグインのメインファイル

readme.txt の例文はこちらを参考に、チェックは公式バリデータで行えます。[your-plugin-name].php には専用のヘッダーコメントを記載する必要があります。

2. Install Subversion

Mac で Subversion を使うためにインストールしておきます。Homebrew で入れる方法が手軽です。

$ brew install subversion

3. Sign up WordPress.org

WordPress.org のアカウントが無ければ、アカウント申請フォームからサインアップします。ログイン状態のまま作業を続けます。

4. Apply plugin

プラグインの初期申請は、Zip ファイルとしてまとめたデータをプラグイン申請フォームからアップロードすることで完了します。問題がある場合はメールで修正の提案などが来ますので、応じて返信しましょう。

5. Connect to Subversion

WordPress からプラグインディレクトリが承認された旨のメールが届きます。この時点ではディレクトリが作成されているだけで中身はありません。まずは発行された Subversion のディレクトリをチェックアウト(Git の clone と同じ)します。ローカルにバージョン管理・アップロードするための場所を作りましょう。

http://plugins.svn.wordpress.org/[your-plugin-name]/ にアクセスすれば、プラグイン用のディレクトリが作成されていることを確認できます。

$ svn co https://plugins.svn.wordpress.org/[your-plugin-name]/ [your-plugin-local-dir]

チェックアウトすると [your-plugin-local-dir] の中に以下のディレクトリが作成されます。

  • assets:ストア用のアイコンやバナー画像用
  • branches:開発中のバージョンやテストコードなどを格納
  • tags:各バージョンごとのデータを保存(中身はコマンドで自動生成)
  • trunk:プラグインデータとスクリーンショット用(最新の本番データ)

6. Add assets

ストア表示を想定して assets ディレクトリ直下に規定サイズの画像を置きます。ファイル名は決められており、形式は PNG または JPEG。SVG のアイコンは無くてもかまいません。

  • banner-1544x500.png
  • banner-772x250.png
  • icon-256x256.png
  • icon-128x128.png
  • icon.svg

ファイルを置いたら Subversion のコマンドでアップロード用のファイルとして追加します。

$ svn add assets/*

7. Add trunk

trunk に公開用のプラグインデータとストアで使うスクリーンショットを置きます。

  • readme.txt
  • [your-plugin-name].php
  • screenshot-1.png
  • etc.

ファイルを置いたら Subversion のコマンドでアップロード用のファイルとして追加します。

$ svn add trunk/*

8. Add tags

trunk のバージョンを管理するためにコマンドでタグ付けを行います。コマンド実行と同時に trunk の複製がバージョン名のディレクトリとなって tags に配置されます。

$ svn cp trunk tags/1.0.0

9. Publish

ファイルを追加し終えたら svn commit コマンドまたは svn ci コマンドを入力しアップロードします。Git と異なり、ローカルにてコミットした時点でセントラルリポジトリへ反映されるようです。最初のコミット時にはアカウントのパスワードを聞かれるので入力しましょう。これで自作プラグインが公式ディレクトリに追加されます。

$ svn commit -m "first release."

10. Update

ファイルを修正した場合は svn update コマンド、削除は svn delete コマンドを使うことで次のアップデートとして登録できます。

$ svn update [filename or dirname/*]
$ svn delete [filename or dirname/*]

readme.txt [your-plugin-name].php 内のバージョン表記やアップデート内容を確認したら、タグ付けを行い公開します。

$ svn cp trunk tags/[new version]
$ svn commit -m "Update release."
Last Updated: 2018-9-30 10:58:52