WordPressプラグインを、VCCWを使って初めて作ってみた(3)

この記事は、WordPressプラグインを、VCCWを使って初めて作ってみた(2)の続きです。この記事では自作したプラグインを公開するまでに必要な手順について説明しています。

目次

  • 公開前にチェックすべきこと
  • 必要なファイル
  • readme.txtの書き方
  • 審査提出
  • 公開

 

公開前にチェックすべきこと

WordPress.orgのプラグインガイドラインをチェックしましょう。

ざくっと各項目のタイトルを訳すとこうなります。

  1. プラグインに含まれるものはGNU一般公衆ライセンス(or 同等)をもつ。(画像やライブラリなども対象)
  2. プラグインがこのガイドラインや他のapiの規約を遵守していることに責任を持つ。
  3. 安定版のプラグインを必ずプラグインディレクトリにアップする。
  4. WordPressコーディングスタンダードに従う。
  5. トライアルソフトウェアではない。
  6. Software as a Serviceは許可されている。
  7. ユーザーの同意なしにトラッキングをしてはならない。
  8. 実行可能なコードを含まない。
  9. 違法、道徳的ではない、非常識なことをしない。
  10. ユーザーの許可なく外部サイトのURLを埋め込まない。
  11. ダッシュボードをハイジャックしない。
  12. readmeをスパムとして使わない。
  13. WordPrssのデフォルトのライブラリを使う。
  14. 頻繁なプラグインのアップデートは避ける。
  15. アップデートの度にバージョンナンバーは更新する。
  16. 提出時には完全なプラグインを提出する。
  17. トレードマーク、著作権、プロジェクトネームを尊敬する。
  18. WordPressコミュニティはプラグインディレクトリを最良の状態に保つための権利をもっている。

今回作成したTw-User-Linkに明らかに関係ない部分は詳細までは読んでいませんが、もっと知りたい方は原文を参考に知てみてください。

WordPress.org | Detailed Plugin Guidelines

 

必要なファイル

プラグイン本体とreadmeファイルになります。

なので僕の場合は以下になります。

  • tw-user-link.php
  • readme.txt

 

readme.txtの書き方

VCCWを利用していればテンプレートが生成されています。ただ僕の場合は迷いました。以下にいくつかのパートに分けて説明します。

パート1

=== Tw User Link ===
Contributors: naoki0h
Donate link: https://example.com/
Tags: twitter link, twitter user name link
Requires at least: 4.4
Tested up to: 4.9.5
Stable tag: 0.1.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

プラグインの情報が要約されています。

  • Contributors:WordPress.orgのユーザーIDです。https://make.wordpress.org/の右上の「Log In / Register」から確認/登録できます。
  • Donate link: 寄付できるページがあればここに書きます。
  • Tags:自分のプラグインに関係のありそうなタグを書きます。複数のタグはコンマで区切ります。
  • Requires at least:プラグインが動く最低限のWordPressのバージョンです。
  • Tested up to: 4.9.5:ユニットテストを実施した最新のWordPressのバージョンです。
  • Stable tag: 0.1.0:現在のプラグインの最新のバージョン。

 

パート2

== Description ==
This plugin automatically adds a link for twitter screen-name.
When you type "ername" in the article, this plugin generates a link to your twitter account.
You don't need to twitter link by yourself. If you have many twitter screen name in your article, this plugin is very effective.

プラグインの説明を書きます。

パート3

== Installation ==

1. Upload `tw-user-link.php` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Place `<?php do_action('plugin_name_hook'); ?>` in your templates

プラグインのインストールの仕方を書きます。

 

パート4

== Frequently Asked Questions ==

= A question that someone might have =

An answer to that question.

= What about foo bar? =

Answer to foo bar dilemma.

よくある質問を書きます。Tw-User-Linkには書いていません。

 

パート5

== Screenshots ==

1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
(or jpg, jpeg, gif).
2. This is the second screen shot

スクリーンショットの説明を書きます。

  • 1番目は、プラグインディレクトリの /assets/screenshot-1.png に対応しています。(プラグインをアップロードするSVNディレクトリは審査にパスした後メールで届きます)2番目以降もscreenshot-xxx.pngというファイル名でアップロードすると対応します。
  •  アップロードした`/assets/screenshot-1.png`と `/tags/4.3/screenshot-1.png`では前者の方が優先されます。

 

パート6

== Changelog ==

= 1.0 =
* A change since the previous version.
* Another change.

= 0.5 =
* List versions from most recent at top to oldest at bottom.

変更内容とバージョンを書きます。

 

パート7

== Upgrade Notice ==

= 1.0 =
Upgrade notices describe the reason a user should upgrade. No more than 300 characters.

= 0.5 =
This version fixes a security related bug. Upgrade immediately.

アップグレードの通知を書きます。(ダッシュボード表示されるのでしょうか?)

 

その他

その他の補足内容を書き足すことができます。有名なプラグインを参考にしてください。

Tw-User-Linkは以下の内容を追加しています。

= Translators =

* Japanese(ja) - [Naoki Ohashi](https://naoki-is.me/)

== Contact ==

twitter 
* https://github.com/naogify/tw-user-link/issues

 

詳細は、WordPress.org | readme.txtをチェックしてみてください。他にもReadme Validatorというチェックツールもあります。活用してみてください。

補足ですが、プラグインページのヘッダー部分に大きなバナー画像を表示するには、772×225pxの png または jpeg の画像を用意し、banner-772×250.pngというファイル名にしてプラグインのassetsレポジトリにコミットします。Retina用に banner-1554×500.pngというサイズも用意可能です。

 

審査提出

 

上記の必要なファイルををZIPファイルにまとめ。WordPress.orgにログインした後(アカウントがなければ作ってください)

下記より提出します。

Add your Plugin

 

プラグインの名前を入力して、

説明文(機能や用途を英語で簡潔に)を入力して。

ZIPファイルをアップロードします。

あとは、審査で数日間待つと登録が承認されたというメールが届きます。

メールには自分のプラグインをアップロードするsubversion(gitのようなバージョン管理システム)レポジトリにアクセスするURLが載っています。

 

Subversionにプラグインをアップロードする

 

ここでは、tw-user-linkを例に説明します。

まず、自分の開発環境に移動します。ローカル開発環境上にリモートレポジトリの内容をチェックアウトしましょう。

$ cd wp-content/plugins/

$ mkdir tw-user-link && cd tw-user-link

$ svn checkout http://plugins.svn.wordpress.org/tw-user-link/trunk/

リビジョン***をチェックアウトしました。

これでリモートレポジトリのtrunkディレクトリがチェックアウトされました。

まだ何もない状態なので、ここに申請したプラグインの内容を取り込みます。

$ cp -R (プラグインのパッケージディレクトリ)/

$ svn add ./*

とりあえずこの状態でコミットしてみましょう。

$ svn commit -m "First commit."

ファイルのデータを送信しています。

リビジョン***をコミットしました。

これでどんどんtrunkの作業用コピーを修正してコミットを繰り返し開発を進めていきます。

 

新しいバージョンをリリースする

 

新しいバージョンをリリースするには、開発しているtrunkディレクトリから、tagsのサブディレクトリへコピーします。

すると自動的にWordPressのプラグインページからダウンロード可能なパッケージが作成されます。

tags/***がそのままバージョンとして扱われるため、ディレクトリ名は tags/0.1.0/ などバージョン名と揃えます。

$ svn copy -m "Tag 1.2.3" http://plugins.svn.wordpress.org/tw-user-link/trunk/ http://plugins.svn.wordpress.org/tw-user-link/tags/1.2.3

リビジョン ******をコミットしました。

これで数分後にWordPressのプラグインページからパッケージがダウンロードできるようになります。

 

新しいバージョンを出す前に

新しいバージョンを出す「前に」readme.txtを更新する必要があります。

  • Requires at least
  • Tested up to
  • Stable tag
  • Changelog
  • Upgrade Notice

Stable tagはプラグイの最新安定バージョーンを指定します。これは trunk 直下にある readem.txtに書かれているものが唯一有効なものとして扱われます。

Change logは前バージョンからの変更点を追記します。

 

まとめ

  • 公開前にチェックすべきこと
  • 必要なファイル
  • ReadMe.txtの書き方
  • 審査提出
  • 公開

 

以上で、WordPressプラグインを、VCCWを使って初めて作ってみたシリーズは終わりです。reademe.txtなど説明しすぎたため、長文になってしまいましたが質問などあれば、 までお願いします。

 

参考