最小フィールド

最低限、ヘッダーコメントにはプラグイン名が含まれている必要があります: 

  1. /*
  2.  * Plugin Name: YOUR PLUGIN NAME
  3.  */

ヘッダーフィールド

利用可能なヘッダーフィールド:

  • プラグイン名: (必須) プラグインの名前で、WordPress管理のプラグインリストに表示されます。
  • プラグインURI: プラグインのホームページで、ユニークなURLである必要があります。できれば自分のウェブサイト上にしてください。これはプラグインに対してユニークでなければなりません。ここでWordPress.orgのURLを使用することはできません。
  • 説明: プラグインの短い説明で、WordPress管理のプラグインセクションに表示されます。この説明は140文字未満にしてください。
  • バージョン: プラグインの現在のバージョン番号、例えば1.0または1.0.3。
  • 少なくとも必要: プラグインが動作する最低限のWordPressバージョン。
  • PHPが必要: 最低限必要なPHPバージョン。
  • 著者: プラグインの著者の名前。複数の著者はカンマで区切って記載できます。
  • 著者URI: 著者のウェブサイトまたは他のウェブサイト上のプロフィール、例えばWordPress.org。
  • ライセンス: プラグインのライセンスの短い名前（スラッグ）（例: GPLv2）。ライセンスに関する詳細はWordPress.orgのガイドラインで確認できます。
  • ライセンスURI: ライセンスの全文へのリンク（例: https://www.gnu.org/licenses/gpl-2.0.html）。
  • テキストドメイン: プラグインのgettextテキストドメイン。詳細はプラグインの国際化方法ページのテキストドメインセクションで確認できます。
  • ドメインパス: ドメインパスはWordPressに翻訳を見つける場所を知らせます。詳細はプラグインの国際化方法ページのドメインパスセクションで確認できます。
  • ネットワーク: プラグインがネットワーク全体でのみ有効化できるかどうか。trueに設定できるのみで、必要ない場合は省略してください。
  • 更新URI: サードパーティのプラグインが、WordPress.orgプラグインディレクトリから同様の名前のプラグインの更新で誤って上書きされるのを避けることができます。詳細は関連する開発ノートをお読みください。
  • 必要なプラグイン: 依存関係のためのWordPress.org形式のスラッグのカンマ区切りリスト、例えばmy-plugin（my-plugin/my-plugin.phpはサポートされていません）。プラグインスラッグ内のカンマはサポートされていません。詳細は関連する開発ノートをお読みください。

有効なPHPファイルのヘッダーコメントは次のようになります: 

  1. /*
  2.  * Plugin Name:       My Basics Plugin
  3.  * Plugin URI:        https://example.com/plugins/the-basics/
  4.  * Description:       Handle the basics with this plugin.
  5.  * Version:           1.10.3
  6.  * Requires at least: 5.2
  7.  * Requires PHP:      7.2
  8.  * Author:            John Smith
  9.  * Author URI:        https://author.example.com/
  10.  * License:           GPL v2 or later
  11.  * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
  12.  * Update URI:        https://example.com/my-plugin/
  13.  * Text Domain:       my-basics-plugin
  14.  * Domain Path:       /languages
  15.  * Requires Plugins:  my-plugin, yet-another-plugin
  16.  */

ファイルレベルのPHPDoc DocBlockとWordPressプラグインファイルヘッダーの両方を許可する別の例は次のとおりです: 

  1. /**
  2.  * Plugin Name
  3.  *
  4.  * @package           PluginPackage
  5.  * @author            Your Name
  6.  * @copyright         2019 Your Name or Company Name
  7.  * @license           GPL-2.0-or-later
  8.  *
  9.  * @wordpress-plugin
  10.  * Plugin Name:       Plugin Name
  11.  * Plugin URI:        https://example.com/plugin-name
  12.  * Description:       Description of the plugin.
  13.  * Version:           1.0.0
  14.  * Requires at least: 5.2
  15.  * Requires PHP:      7.2
  16.  * Author:            Your Name
  17.  * Author URI:        https://example.com
  18.  * Text Domain:       plugin-slug
  19.  * License:           GPL v2 or later
  20.  * License URI:       http://www.gnu.org/licenses/gpl-2.0.txt
  21.  * Update URI:        https://example.com/my-plugin/
  22.  * Requires Plugins:  my-plugin, yet-another-plugin
  23.  */

ノート

プロジェクトにバージョン番号を割り当てる際は、WordPressがプラグインのバージョン番号を比較するためにPHPのversion_compare()関数を使用することを考慮してください。したがって、新しいバージョンのプラグインをリリースする前に、このPHP関数が新しいバージョンを古いバージョンよりも「大きい」と見なすことを確認する必要があります。例えば、1.02は実際には1.1よりも大きいです。