正如入门指南中所描述的那样,主要的 PHP 文件应包含一个头部注释,该注释告知 WordPress 这是一个插件并提供有关该插件的信息。

最小字段

至少,头部注释必须包含“插件名称”:

/*
 * Plugin Name: YOUR PLUGIN NAME
 */

头部字段

可用的头部字段:

  • Plugin Name: (必需) 您的插件的名称,将在 WordPress 管理后台的插件列表中显示。
  • Plugin URI: 插件的主页,应为一个唯一的 URL,最好是在您自己的网站上。此字段 必须唯一属于您的插件。此处不能使用 WordPress.org 的 URL。
  • Description: 在 WordPress 管理后台的插件部分显示的插件简短描述。请保持该描述少于 140 个字符。
  • Version: 插件的当前版本号,例如 1.0 或 1.0.3。
  • Requires at least: 插件可运行的最低 WordPress 版本。
  • Requires PHP: 所需的最低 PHP 版本。
  • Author: 插件作者的姓名。可以使用逗号列出多位作者。
  • Author URI: 作者的网站或另一个网站(如 WordPress.org)上的个人资料链接。
  • License: 插件许可证的简短名称(slug),例如 GPLv2。有关许可的更多信息,请参阅WordPress.org 指南。
  • License URI: 指向许可证全文的链接(例如 https://www.gnu.org/licenses/gpl-2.0.html)。
  • Text Domain: 插件的gettext 文本域。更多信息请参阅文本域部分,位于如何国际化您的插件页面。
  • Domain Path: 域路径让 WordPress 知道在哪里查找翻译。更多信息请参阅域路径部分,位于如何国际化您的插件页面。
  • Network: 插件是否可以仅在全网范围内激活。只能设置为 true,在不需要的情况下应省略此字段。
  • Update URI: 允许第三方插件避免被 WordPress.org 插件目录中名称相似的插件的更新意外覆盖。有关更多信息,请阅读相关的开发者笔记。
  • Requires Plugins: 其依赖项的逗号分隔列表,这些依赖项是 WordPress.org 格式的 slug,例如my-plugin(不支持my-plugin/my-plugin.php)。它不支持插件 slug 中包含逗号。有关更多信息,请阅读相关的开发者笔记。

一个带有头部注释的有效 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
 */

这是另一个示例,允许同时使用文件级别的 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:       http://www.gnu.org/licenses/gpl-2.0.txt
 * Update URI:        https://example.com/my-plugin/
 * Requires Plugins:  my-plugin, yet-another-plugin
 */

注意事项

在为项目分配版本号时,请记住 WordPress 使用 PHP 的 version_compare() 函数来比较插件版本号。因此,在发布新版本的插件之前,您应确保该 PHP 函数认为新版本“大于”旧版本。例如,1.02 实际上大于 1.1。