入門で説明したように、メイン PHP ファイルには、ファイルがプラグインであることを WordPress に伝え、プラグインに関する情報を提供するヘッダーコメントを含める必要があります。
最小フィールド
少なくとも、ヘッダーコメントにはプラグイン名を含める必要があります。
<?php
/**
* Plugin Name: YOUR PLUGIN NAME
*/
ヘッダーフィールド
利用可能なヘッダーフィールド:
- Plugin Name:(必須)WordPress Admin のプラグインリストに表示されるプラグインの名前。
- Plugin URI:プラグインのホームページ。一意の URL である必要があります(できれば独自の Web サイト上にあります)。これはプラグインに固有でなければなりません。ここでは WordPress.org の URL を使用できません。
- Description:WordPress Admin の「プラグイン」セクションに表示されるプラグインの簡単な説明。この説明は140文字未満にしてください。
- Version:プラグインの現在のバージョン番号(1.0や1.0.3など)。
- Requires at least:プラグインが動作する最低の WordPress バージョン。
- Requires PHP:最低限必要な PHP バージョン。
- Author:プラグイン作成者の名前。カンマを使用して複数の著者をリストできます。
- Author URI:WordPress.org など、別の Web サイトの著者のWebサイトまたはプロファイル。
- License:プラグインのライセンスの短い名前(スラッグ)(GPL2 など)。ライセンスの詳細については、WordPress.org のガイドラインをご覧ください。
- License URI:ライセンスの全文へのリンク(例:https://www.gnu.org/licenses/gpl-2.0.html)。
- Text Domain:プラグインの gettext テキストドメイン。詳細については、「プラグインを国際化する方法」ページの「テキストドメイン」セクションを参照してください。
- Domain Path:ドメインパスにより、WordPress は翻訳の場所を知ることができます。詳細については、「プラグインを国際化する方法」ページの「ドメインパス」セクションを参照してください。
- Network:プラグインをネットワーク全体でのみアクティブ化できるかどうか。 true にのみ設定でき、不要な場合は除外する必要があります。
<?php
/**
* Plugin Name: My Basics Plugin
* Plugin URI: https://example.com/plugins/the-basics/
* Description: Handle the basics with this plugin.
* Version: 1.10.3
* Requires at least: 5.2
* Requires PHP: 7.2
* Author: John Smith
* Author URI: https://author.example.com/
* License: GPL v2 or later
* License URI: https://www.gnu.org/licenses/gpl-2.0.html
* Text Domain: my-basics-plugin
* Domain Path: /languages
*/
プラグインヘッダージェネレーターを使用して、さまざまなヘッダーフィールドで遊ぶことができます。
次に、ファイルレベルの PHPDoc DocBlock と WordPress プラグインファイルヘッダーを許可する別の例を示します。
<?php
/**
* Plugin Name
*
* @package PluginPackage
* @author Your Name
* @copyright 2019 Your Name or Company Name
* @license GPL-2.0-or-later
*
* @wordpress-plugin
* Plugin Name: Plugin Name
* Plugin URI: https://example.com/plugin-name
* Description: Description of the plugin.
* Version: 1.0.0
* Requires at least: 5.2
* Requires PHP: 7.2
* Author: Your Name
* Author URI: https://example.com
* Text Domain: plugin-slug
* License: GPL v2 or later
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
*/
注釈
プロジェクトにバージョン番号を割り当てる場合、WordPress はプラグインのバージョン番号を比較するために PHP version_compare() 関数を使用する時に注意してください。 したがって、プラグインの新しいバージョンをリリースする前に、この PHP 関数が新しいバージョンを古いバージョンよりも「大きい」と見なすようにしてください。 たとえば、1.02 は実際には 1.1 より大きくなります。
このページの原文はこちら(Header Requirements)です。