(36) 【WORDPRESS】自作プラグインを公式ディレクトリに登録

投稿者: | 2017年9月5日

この記事は最終更新から 443日 が経過しています。

良いプラグインが完成したら、世界中の数千万人のWORDPRESSユーザーの方々にも使ってもらいたい。
そうやって機能を増やしながら WORDPRESSは進化してきた。

今回は自作のプラグインをWORDPRESSの公式ディレクトリに登録してみる。
ネット上にこの内容でたくさんの諸先輩方の記事が掲載されている。
今回は実際に自分でやってみた備忘録として記録しておく。

(1) WORDPRESS.ORGのアカウントを作成

1) wordpress.orgにアクセスする。 ※.comではないので注意!

https://wordpress.org/

2) Pluginページを開く。

3) 右上の「Register」を押す。

4) ユーザー名とメアドを入力する。 → メールでパスワードが通知される。

5) メールで指示されたページにアクセスして必要事項を入力する。

 ↓
WORDPRESS.ORGのアカウント登録が完了!

(2) プログラム以外のファイル作成

1) readme.txtを作成する。 【必須】

作成したファイルはプラグインプログラムと同じディレクトリに置く。
こちら(↓)のサイトを利用すると楽に作成できる。
https://stuff.trepmal.com/wp-readme-generator/
書き方に迷ったら自サイトにインストール済みのプラグインの readme.txtを参考にする。
中学1年生レベルの英語で問題なし。

2) スクリーンショット画像を2枚作成する。

画像サイズは自由、640 x 480 ぐらいが丁度よいようだ。
実際にプラグインページで Screenshotsがどのように表示されているかを見てみるとよい。
https://wordpress.org/plugins/syntaxhighlighter/
作成した画像ファイルはプラグインプログラムと同じディレクトリに置く。
作成した画像ファイル名は、上記の readme.txtの「== Screenshots ==」セクションに記載する。
「使用中の画面」、「設定画面の一部」の2枚の画像を使うのが一般的なようだ。

== Screenshots ==
1. screenshot-1.png
2. screenshot-2.png

(3) 自作プラグインの登録申請

1) WORDPRESS.ORGにログインする。

2) 「Add Your Plugin」ページを開く。

https://wordpress.org/plugins/developers/add/

3) プラグインファイル一式をZIPファイルにパックする。

登録申請に必要な全ファイルをまとめて…

1個のZIPファイルにする。

4) [Select File]ボタン押下でZIPファイルを選択、[Upload]ボタン押下でアップロードする。

(4) Approveされるのを待つ

1) 待つ

申請時に以下のように行列待ち数が表示される。7営業日は問合せも控えるようにとのこと。
混雑具合にもよるのだろうが、プログラム量の小さなプラグインであれば1~2時間で認められるようだ。

2) 申請結果を受信

WORDPRESS.ORGにユーザー登録したメアド宛に結果が届く。
メールには当該プラグイン用のSubversionリポジトリが書かれており、ここにプラグインファイル一式を登録することになる。

(5) プラグインファイル一式をSubversionに登録

上記(3)の申請時に送付したプラグインファイル一式は、あくまでも審査のために送ったものであり、相手側がそれを公式ディレクトリに公開してくれる訳ではない。上記(4)-2)で受信したメールに書かれているSubversionリポジトリに自分で登録する必要がある。

1) TortoiseSVNをインストールする。

Windows環境で作業する場合、TortoiseSVNをインストールすると便利だ。
https://tortoisesvn.net/

2) プラグインファイル用ディレクトリを作成する。

好きな位置に好きな名前で作成する。

3) チェックアウトする。

上記(4)-2)で受信したメールに書かれているSubversionリポジトリのクローンを自環境に作成する。
上記2)で作成したディレクトリを右クリックしてポップアップメニューを開き、[SVN Checkout…]を選択する。

「URL of repository」項目には、上記(4)-2)で受信したメールに書かれているSubversionリポジトリのURLを入力する。

すると、assets, branches, tags, trunkの4個の空のディレクトリが作成された。

4) 自作プラグインファイルを置く

trunkディレクトリの直下に自作のプラグインファイル一式を置く。

assetsディレクトリの直下にスクリーンショット画像を置く。

5) Commitする。

Commitしてクローン環境の変更をマスター環境に反映させる。

完了!

しばらく待つと、以下の新プラグイン紹介ページに自作プラグインが表示されているはずです。
https://wordpress.org/plugins/browse/new/
ここで作業を終えてしまっても何も問題はありません。

さらに…

1) バナー画像を作成する。

プラグイン紹介画面のヘッダ部分に表示されているのが「バナー画像」だ。

バナー画像は、上記(5)-3)で作成された assets ディレクトリに置くことになっている。
詳細はこちらの公式サイトの説明を参照のこと。
How Your Plugin Assets Work
バナー画像のファイル名、画像形式および画像サイズは決められているのでそれに従う。
画質を気にしないならば通常サイズだけでもよいようだ。
・通常画像: banner-772×250.png (or .jpg)
・高画質画像: banner-1544×500.png (or .jpg)

作成した画像ファイルを assets ディレクトリに置き、前述の(5)-5)の要領で Commitすればよい。
数分以内に画像が反映される。

2) アイコン画像を作成する。

プラグイン一覧表示に使われている正方形の小さな画像が「アイコン画像」だ。

アイコン画像は、上記(5)-3)で作成された assets ディレクトリに置くことになっている。
アイコン画像のファイル名、画像形式および画像サイズも決められているのでそれに従う。
画質を気にしないならば通常サイズだけでもよいようだ。
・通常画像: icon-128×128.png (or .jpg)
・高画質画像: icon-256×256.png (or .jpg)

作成した画像ファイルを assets ディレクトリに置き、前述の(5)-5)の要領で Commitすればよい。
数分以内に画像が反映される。

3) ここまでの出来具合

こんな感じで自作プラグインが紹介されています。
投稿文やウィジェットにショートコードを記述すると、野球のスコアボードを表示するプラグインです。
馬子にも衣装と言いますか…それっぽく見えます。

4) バージョン管理する。

書き疲れたので後日追記する…


コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です


日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)