[WordPress]プラグインを自作する時のヘッダーコメント

WordPressプラグインを作成するファイルヘッダーの書き方です。
「Plugin Name」さえ記載すればプラグインとして認識されます。

<?php
/**
 * Plugin Name: プラグインの名前【必須】
 * Plugin URI: プラグインのURL
 * Description: プラグインの説明(140字未満)
 * Version: プラグインの現在バージョン
 * Requires at least: プラグインが動作するWordPressの最低バージョン
 * Requires PHP: プラグインが動作するPHPの最低バージョン
 * Author: プラグインの作者(複数ある場合コンマでリスト化可能)
 * Author URI: プラグイン作者のWebサイトURL
 * License: プラグインのライセンスの短縮名
 * License URI: ライセンスの全文へのリンク
 * Update URI: プラグインの更新で誤って上書きされるのを防ぐ *1
 * Text Domain: プラグインのドメイン名 *2
 * Domain Path: プラグインを翻訳するフォルダ相対パス
 */

*1サードパーティのプラグインが、WordPress.orgプラグインディレクトリからの同様の名前のプラグインの更新で誤って上書きされるのを防ぐことができる。
参考:https://make.wordpress.org/core/2021/06/29/introducing-update-uri-plugin-header-in-wordpress-5-8/

*2プラグインを識別するためのユニークな名前で、通常はプラグイン名を使用する。
参考:https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/

自作プラグインでよく使うサンプル

<?php
/**
 * Plugin Name: プラグインの名前【必須】
 * Description: プラグインの説明(140字未満)
 * Version: プラグインの現在バージョン
 * Author: プラグインの作者(複数ある場合コンマでリスト化可能)
 * Author URI: プラグイン作者のWebサイトURL
 */

タイトルとURLをコピーしました