WordPress プラグイン作成用ヘッダーコメントまとめ

WordPress

WordPressのプラグインを自作する際に記述するヘッダーコメントのテンプレートと解説。

全部入り

/*
 * 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
 * Update URI:        https://example.com/my-plugin/
 * Text Domain:       my-basics-plugin
 * Domain Path:       /languages
 */

ミニマム

/*
 * Plugin Name: YOUR PLUGIN NAME
 */

説明

Plugin Name
必須。WordPress管理画面のプラグインリストに表示されるプラグインの名前。
Plugin URI
プラグインのホームページURL。WordPress.orgのURLは使用できない。
Description
WordPress管理画面のプラグインリストに表示される、プラグインの短い説明。140文字以内で記述。
Version
プラグインの現在のバージョン番号。
Requires as least
プラグインの動作に最低限必要なWordPressのバージョン。
Requires PHP
プラグインの動作に最低限必要なPHPのバージョン。
Author
プラグイン作者の名前。カンマで区切って複数の作者を指定することもできる。
Author URI
作者のウェブサイト、またはWordPress.orgなどほかのサイト上のプロフィール。
License
プラグインのライセンスのスラッグ(例:GPL v2)。ライセンスの詳細はWordPress.org のガイドラインを参照ください。
License URI
ライセンスの全文へのリンク。(例:https://www.gnu.org/licenses/gpl-2.0.html
Update URI
サードパーティのプラグインが、WordPress.org Plugin Directory にある似た名前のプラグインの更新で誤って上書きされるのを防ぐ。
Text Domain

プラグインのgettextテキストドメイン。詳細はプラグインの国際化方法のページのText Domainのセクションを参照ください。
Domain Path
ドメインパスはWordPressに翻訳がどこにあるかを知らせます。詳しくはプラグインの国際化方法Domain Pathのセクションをご覧ください。

参考