📝 readme.txt の作成

readme.txt はプラグインの説明書です。WordPress.org のプラグインページに表示される情報が、この1つのファイルから生成されます。

=== My First Plugin === Contributors: あなたのWordPress.orgユーザー名 Donate link: https://example.com/donate/ Tags: hello, world, sample Requires at least: 5.0 Tested up to: 6.4 Requires PHP: 7.4 Stable tag: 1.0.0 License: GPLv2 or later License URI: https://www.gnu.org/licenses/gpl-2.0.html 管理画面にメッセージを表示するシンプルなプラグインです。 == Description == My First Plugin は、WordPress 管理画面にカスタムメッセージを表示できるプラグインです。 = 主な機能 = * 管理画面にメッセージを表示 * 設定画面でメッセージを変更可能 * 軽量で高速 = 使い方 = 1. プラグインを有効化します 2. 管理画面 → マイプラグイン設定 を開きます 3. 表示したいメッセージを入力して保存します == Installation == 1. プラグインファイルを `/wp-content/plugins/my-first-plugin` ディレクトリにアップロードします 2. WordPress の「プラグイン」メニューからプラグインを有効化します == Frequently Asked Questions == = メッセージを非表示にするには? = プラグインを無効化してください。 == Screenshots == 1. 設定画面のスクリーンショット 2. 管理画面に表示されたメッセージ == Changelog == = 1.0.0 = * 初回リリース == Upgrade Notice == = 1.0.0 = 初回リリースです。

readme.txt の主要セクション

ヘッダー部分(必須)

Requires at least(対応最低WordPressバージョン)、Tested up to(動作確認済み最新バージョン)、Requires PHP(必要なPHPバージョン)は必ず記載しましょう。

== Description ==(説明)

プラグインの機能を詳しく説明します。Markdownに似た記法が使えます。最初の数行が検索結果の要約として表示されます。

== Changelog ==(変更履歴)

バージョンごとの変更内容を記録します。ユーザーが更新前に変更点を確認できるため、必ず記載しましょう。

🎨 プラグインアイコン・バナーの準備

WordPress.org のプラグインページに表示されるビジュアル素材を準備します。

ファイル名サイズ用途
icon-128x128.png128×128pxプラグイン一覧のアイコン(標準)
icon-256x256.png256×256pxプラグイン一覧のアイコン(Retina対応)
banner-772x250.png772×250pxプラグイン詳細ページのバナー(標準)
banner-1544x500.png1544×500pxプラグイン詳細ページのバナー(Retina対応)

これらのファイルは SVN リポジトリの assets/ フォルダに配置します(後述)。

💡 アイコンは SVG でも OK

PNG の代わりに SVG ファイル(icon.svg)を1つ用意すれば、すべての解像度に対応できます。

🌍 WordPress.org への登録手順

プラグインを公開するには、WordPress.org の審査を通過する必要があります。

ステップ1: WordPress.org アカウントを作成

wordpress.org でアカウントを作成します。すでにお持ちの場合はそのままでOKです。

ステップ2: プラグインを申請する

プラグイン申請ページにアクセスし、プラグインの ZIP ファイルをアップロードします。

ステップ3: レビュー審査を待つ

WordPress.org のチームが手動でコードを審査します。審査には通常1〜2週間かかります。問題があればメールで連絡が来ます。

ステップ4: SVN でファイルを公開

審査が通ると SVN リポジトリが発行されます。SVN を使ってファイルを公開します(後述)。

⚠️ 審査で引っかかりやすいポイント

  • nonce による検証がない
  • 入力値のサニタイズ・エスケープが不十分
  • GPL 互換でないコードやライブラリの使用
  • readme.txt の必須項目が不足している
  • 他のプラグインと重複するスラッグ名

🔄 SVN(Subversion)の使い方

WordPress.org はバージョン管理に SVN を使っています。Git と似た概念ですが操作方法が異なります。

SVN リポジトリの構造

my-first-plugin/ ← SVN リポジトリのルート ├── trunk/ ← 開発中(最新)のコード │ ├── my-first-plugin.php │ └── readme.txt ├── tags/ ← リリースバージョン(公開用) │ ├── 1.0.0/ │ │ ├── my-first-plugin.php │ │ └── readme.txt │ └── 1.1.0/ └── assets/ ← アイコン・バナー画像 ├── icon-128x128.png ├── icon-256x256.png └── banner-772x250.png

基本的な SVN コマンド

# リポジトリをローカルにチェックアウト svn co https://plugins.svn.wordpress.org/my-first-plugin/ . # ファイルの変更を確認 svn status # 新しいファイルを追加 svn add trunk/my-first-plugin.php # 変更をコミット(公開) svn ci -m "Initial commit: version 1.0.0" # バージョンタグを作成(trunk から 1.0.0 にコピー) svn cp trunk tags/1.0.0 svn ci -m "Tagging version 1.0.0"

💡 SVN の代わりに GitHub を使う方法

SVN が難しい場合は、GitHub Actions を使って GitHub から WordPress.org SVN に自動デプロイする方法があります。10up/action-wordpress-plugin-deploy アクションを使うと、GitHub に push するだけで自動公開できます。

📌 バージョン管理とアップデート

バージョン番号のルール(セマンティックバージョニング)

1.0.0 ↑ ↑ ↑ │ │ └── パッチ: バグ修正(後方互換性あり) │ └──── マイナー: 機能追加(後方互換性あり) └────── メジャー: 大きな変更(後方互換性なし)

アップデートの公開手順

  1. コードを修正して trunk にコミット
  2. readme.txt の Stable tagChangelog を更新
  3. プラグインヘッダーの Version を更新
  4. SVN で新しいタグを作成(例: tags/1.1.0
  5. WordPress.org に自動的にアップデートが通知される

⚠️ readme.txt の Stable tag を忘れずに

Stable tag を新しいバージョン番号に更新しないと、ユーザーにアップデートが通知されません。タグの作成と Stable tag の更新はセットで行いましょう。

✅ 公開前の最終チェックリスト

  • readme.txt に必須項目がすべて記載されている
  • プラグインヘッダーのバージョンと readme.txt の Stable tag が一致している
  • すべての入力値にサニタイズ・エスケープが実装されている
  • nonce による検証がすべてのフォームに実装されている
  • current_user_can() による権限チェックが実装されている
  • プラグインを無効化しても他の機能に影響しない
  • 最新バージョンの WordPress と PHP で動作確認済み
  • GPL 互換のライセンスを使用している
  • アイコン・バナー画像を準備した(任意)
  • 翻訳対応(Text Domain)が設定されている

🎉 基礎編 全6ステップ 完了!

お疲れ様でした!これでWordPressプラグイン開発の基礎をすべて学びました。さらにスキルアップしたい方は、応用編にチャレンジしてみましょう!

応用編へ進む →