WordPress.org プラグインディレクトリに自作プラグインを登録
WordPress.org プラグインディレクトリについて
プラグインの開発が完了したら、せっかくなのでいろいろな人に使ってもらいたいです
WordPressでは、管理画面上からプラグインの検索とインストールが容易に出来るようになっています
しかも、バージョンアップ管理もその場所で行うことができるので管理者にとってはこの上なく便利なシステムとなっています。
せっかく作ったプラグインならこの機能を利用しなければ持った得ないです。
そのプラグインディレクトリに登録をしていく手順などを公開していこうと思います。
WordPress.org プラグインディレクトリの規則
登録といっても、 文字情報だけではなくサーバーの容量を借りてプラグインを公開していただく場なので、規則があります。
下記の内容に準じたプラグインでなければ登録することは出来ないことになっています。
- プラグインのライセンスはGPLに準拠していなければならない。
- 公序良俗に反するようなことはしてはならない。
ほとんど問題になるようなことはないと思います。
あと、ファイルの管理はFTPなどでアップロードを行うのではなくsubversionを使って管理することになります。
こちらの方法なども追って説明していきます。
ステップ１ WordPress.org のアカウントの登録
まずは、WordPress.org にユーザー登録をします。
WordPress.org [https://wordpress.org/]
2011年8月現在はトップページには、ログインやユーザー登録へのリンクなどはありません。
ExtendやForumsのページから登録することが出来ますのでそちらからユーザー登録を行います。
クリックするとユーザー登録フォームが表示されます。
登録に必要な内容を入力して登録をします。
登録完了して無事ログインが出来ると、ログインフォーム部分がアカウント名になります。
これで、無事ログイン出来たので続いてプラグインの登録申請をしたいと思います。
ステップ２ 自作プラグインの登録申請
プラグイン登録については、プラグインページから行います。
プラグインのページからDeveloper Centerへ階層を移動すると登録手順が記載されています。
通常そちらを ご参照いただいた方が誤りも少ないと思います。
この記事が古い情報になっている事もあるので念のためにデベロッパーセンターの説明に目を通しておいてください。
確認したら、プラグインの追加を行います。
下記のリンクから申請フォームに飛びます。
Add Your Pluginをクリックすると追加申請フォームが表示されます。
申請の内容は
- Plugin Name
- Plugin Description
- Plugin URL
以上の3つだけです。
入力はすべて英語にて入力してください。
日本語ではおそらくですが登録は出来ないと思います。
登録申請すると審査が入るため、しばらく許可が下りるまでに時間がかかります。
僕は３日 ほどかかりました。
ユーザー登録したときのメールアドレスに 下記のようなメールが届きます。
|
picmo,
Your plugin hosting request has been approved. Within one hour, you will have access to your SVN repository at https://plugins.svn.wordpress.org/typepad-emoji-for-tinymce/ with your WordPress.org/bbPress.org username and password (the same one you use on the forums). Here’s some handy links to help you get started. Using Subversion with the WordPress Plugins Directory FAQ about the WordPress Plugins Directory WordPress Plugins Directory readme.txt standard readme.txt validator: Enjoy! |
このようなメールが届けばあとは実際にプラグインを登録する作業になります。
ステップ３ subversion のインストール
コマンドラインでの svn コマンドを使って操作する方法も Developer CenterのUsing Subversionで紹介されていますがWindowsの場合、GUIでTortoiseSVNというプログラムがあります。
そちらのプログラムを使わせていただいて進めたいと思います。
TortoiseSVN [https://sourceforge.jp/projects/tortoisesvn/]
TortoiseSVNはSourceForge.JPからダウンロードできます。
インターフェースを日本語にするLanguage packsも用意されています。
必要なバージョンと言語パックをダウンロードしてインストールを行ってください。
tortoiseSVNが無事インストール完了するとエクスプローラーの右クリックメニューに統合されメニュー項目が表示されるようになります。
ステップ４ プラグインの登録
では、プラグインの登録を行ってみます。
プラグインの名称でフォルダを作り、そのフォルダで右クリックすることでSVNチェックアウトの項目が表示されます。
選択すると登録画面が表示されます。
メールで送られてきたリポジトリのＵＲＬを入力します。
すると新規で作ったフォルダの中にプラグインディレクトリにあるフォルダなどが自動で取得されて表示されます。
続いてプラグインプログラムやreadmeなどの準備をして登録作業を行います。
readmeはwordpressでサンプルがありますのでそちらを参考に作られると良いと思います。
英語でわかりにくいという方は、こちらのページで翻訳してくれています。
素敵です
できあがったreadmeは、チェックツールが準備されています。
WordPress/BBPress Plugin readme.txt Validator
作ったreadmeを早速試して見ます。
怪しい英語ではありますが、とりあえず要件は満たしているようです。
それでは、アップロードファイルを準備しましょう。
チェックアウトして作られたフォルダのtrunkフォルダにプラグイン本体ファイル一式と先ほど作ったreadme.txtを入れます。
スクリーンショットの画像があるときは、一緒にscreenshot-1.png、screenshot-2.png・・・の要領で追加していくことが出来ます。
このときreadme.txtにスクリーンショットのキャプションも入れることが出来ますので有る場合は追加しておくとよいと思います。
trunkのフォルダ内を参照した状態で右クリックのメニューを表示させると
SVNコミットの表示がありますので、これをクリックします。
下に更新されたファイルの一覧が表示されますので、コミットしたいファイルにチェックをつけてＯＫをクリックします。
（上の写真の更新ファイル数が 少ないのはスクリーンショットを取り忘れたため、一つだけ更新して表示させました。)
つづいてWordPress.orgのＩＤとパスワードを聞かれますので、入力するとアップロードが実行されます。
無事アップロードか完了するとWordPress.orgのプラグインページでNewest Pluginsに公開されます。
やはりすぐには反映されず更新までに数分ほど要しましたが、長い場合もあるようです。
記念すべき初プラグイン登録です
無事登録が完了しましたら中に入って内容を確認してみましょう。
誤りがあったら修正などをして再度コミットすれば更新されます。
ステップ５ バージョンの管理
subversionはバージョン管理が容易に出来るように開発されているシステムなので、バージョン管理もしっかりとやっていきたいと思います。
最新版はtrunkフォルダに入れ、tagsフォルダでは過去のバージョンを管理します。
現在はtrunkに最新バージョンの一式がアップロードされている状態ですので、そのバージョンをtagsにコピーしておきたいと思います。
trunkフォルダで右クリックを押してメニューを表示させます。
ブランチ／タグをクリックします。
ブランチ／タグのウィンドウでは、作業コピーのURL(コピー元)から先URL(コピー先)のフォルダの指定をします。
いずれもサーバー上で実行される指定です。
僕のプラグインは現在最新版が1.1なので、1.1というフォルダを指定しました。
完了のメッセージが表示されればサーバー上でのコピーは完了です。
ローカルでは、とくに変化がありませんのでローカルのフォルダにもサーバーと同じ内容を同期させます。
右クリック見ニューからSVN更新を押します。
すると、サーバー上で作った1.1のフォルダがローカル上にも反映されました。
もし、次のバージョンがアップする際にはまた新しいバージョン番号で管理していくと管理も楽に出来ます。
関連のありそうなエントリ
