WordPress插件开发:头部注释
编辑文章插件的主PHP文件应包含头部注释字段,用来告诉WordPress,这个插件的详细信息。
一个有效的插件头部是由PHP注释块(/* */ 或 /** */)包裹的一系列字段列表,通常放在插件主文件顶部。
字段说明
下面是所有可用字段及其含义:
| 字段名称 | 是否必需 | 说明 |
|---|---|---|
| Plugin Name | 必须 | 插件名称,将在WordPress后台的插件列表中显示。 |
| Plugin URI | 可选 | 插件的主页地址,应为你的网站上的唯一URL,不能使用WordPress.org的地址。 |
| Description | 可选 | 插件的简短描述(建议少于140字符),在后台插件列表显示。 |
| Version | 可选 | 插件的当前版本号(如1.0.3)。 |
| Requires at least | 可选 | 插件可运行的最低WordPress版本。 |
| Requires PHP | 可选 | 插件要求的最低PHP版本。 |
| Author | 可选 | 插件作者名称,多个作者可用逗号分隔。 |
| Author URI | 可选 | 作者的网站地址。 |
| License | 可选 | 插件的许可证缩写(例如GPL v2 or later)。 |
| License URI | 可选 | 指向许可证全文的链接。 |
| Text Domain | 可选 | 用于插件国际化/本地化的文本域。 |
| Domain Path | 可选 | 告知WordPress翻译文件的存放路径(例如 /languages)。 |
| Network | 可选 | 如果插件只能在整个站点网络(Network-wide)激活,则设置为 true。 |
| Update URI | 可选 | 用于防止第三方插件被WordPress.org插件目录中同名插件意外覆盖。 |
| Requires Plugins | 可选 | 插件所依赖的其他插件的slug列表(以逗号分隔,格式如 my-plugin)。 |
一个带有头部注释的有效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
* Update URI: https://example.com/my-plugin/
* Text Domain: my-basics-plugin
* Domain Path: /languages
* Requires Plugins: my-plugin, yet-another-plugin
*/
最少字段
创建插件时,只有 Plugin Name 字段是必须的,其他所有字段均为可选。因此,头部注释至少包含插件名称:
/*
* Plugin Name: YOUR PLUGIN NAME
*/