ヘッダーの必要条件

はじめに説明したように、メインの PHP ファイルには、ファイルがプラグインであることを WordPress に伝え、プラグインに関する情報を提供するヘッダーコメントを含める必要があります。

最低限の項目

最低限、ヘッダーコメントには「Plugin Name」を含める必要があります:

/*
 * Plugin Name: YOUR PLUGIN NAME
 */

ヘッダー項目

利用可能なヘッダー項目:

• Plugin Name: (必須) WordPress 管理画面のプラグインリストに表示される、プラグインの名前です。
• Plugin URI: これはプラグインのホームページであり、できればあなた自身の Web サイトにあるユニークな URL でなければなりません。これはあなたのプラグイン独自のものでなければなりません。WordPress.org の URL は使用できません。
• Description: WordPress 管理画面のプラグインセクションに表示される、プラグインの短い説明です。この説明は140文字以内に収めてください。
• Version: 1.0や1.0.3など、プラグインの現在のバージョン番号です。
• Requires at least: プラグインが動作する WordPress の最低バージョンです。
• Requires PHP: 最低限必要な PHP のバージョンです。
• Author: プラグイン作者の名前です。カンマを使って複数の作者を列挙できます。
• Author URI: 作者の Web サイト、または WordPress.org のような、他の Web サイト上のプロフィールです。
• License: プラグインのライセンスの短い名前 (スラッグ) です (例: GPLv2)。ライセンスの詳細については、WordPress.org のガイドラインを参照してください。
• License URI: ライセンスの全文へのリンクです (https://www.gnu.org/licenses/old-licenses/gpl-2.0.html 等)。
• Text Domain: プラグインの gettext テキストドメインです。詳細は、プラグインを国際化する方法ページのテキスト・ドメインセクションを参照してください。
• Domain Path: ドメインパスによって、WordPress に翻訳の場所を知らせることができます。詳細は、プラグインを国際化する方法ページのドメイン・パスセクションを参照してください。
• Network: プラグインをネットワーク全体でのみ有効にするか否かを指定します。true にしか設定できないので、必要ない場合は設定しないでください。
• Update URI: (重要: WordPress.org プラグイン・ディレクトリでホストされているプラグインには絶対に使用しないでください。) これにより、WordPress.org 以外のプラグインが、WordPress.org プラグイン・ディレクトリにある似た名前のプラグインのアップデートで誤って上書きされるのを防ぐことができます。詳細は、関連する開発者ノートを参照してください。

ヘッダーコメントを持つ有効な 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 プラグインのファイルヘッダーを許可する、別の例です:

/**
 * 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:       https://www.gnu.org/licenses/gpl-2.0.txt
 */

備考

原文 / 日本語訳