跳转到主要内容

标题要求

如入门中所述，主 PHP 文件应包含标头注释，告诉 WordPress 该文件是一个插件并提供有关该插件的信息。

最小字段

标头注释至少必须包含插件名称：

/*
 * Plugin Name: YOUR PLUGIN NAME
 */

标头字段

可用的标头字段：

  • 插件名称：（必填）您的插件的名称，该名称将显示在 WordPress 管理中心的插件列表中。
  • 插件URI：插件的主页，应该是唯一的URL，最好在您自己的网站上。这对于您的插件来说必须是唯一的。您不能在此处使用 WordPress.org URL。
  • 描述：插件的简短描述，如 WordPress 管理中的插件部分所示。请将此描述控制在 140 个字符以内。
  • 版本：插件的当前版本号，例如 1.0 或 1.0.3。
  • 至少需要：插件可以运行的最低 WordPress 版本。
  • 需要 PHP：所需的最低 PHP 版本。
  • 作者：插件作者的姓名。可以使用逗号列出多个作者。
  • 作者 URI：作者的网站或其他网站（例如 WordPress.org）上的个人资料。
  • 许可证：插件许可证的简称（slug）（例如GPLv2）。有关许可的更多信息可以在WordPress.org 指南中找到。
  • 许可证 URI：许可证全文的链接（例如https://www.gnu.org/licenses/gpl-2.0.html）。
  • 文本域：插件的gettext文本域。更多信息可以在如何国际化插件页面的文本域部分找到。
  • 域路径：域路径让 WordPress 知道在哪里可以找到翻译。更多信息可以在如何国际化插件页面的域路径部分找到。
  • 网络：插件是否只能在网络范围内激活。只能设置为true，不需要时应省略。
  • 更新 URI：允许第三方插件避免意外被 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
 * Update URI:        https://example.com/my-plugin/
 * 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:       http://www.gnu.org/licenses/gpl-2.0.txt
 * Update URI:        https://example.com/my-plugin/
 */

笔记

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

 

 

无评论
回到顶部