WordPress标头要求和标头字段如何定义？

WordPress标题要求如何定义？

正如WordPress入门中所述，主 PHP 文件应包含标头注释，告诉 WordPress 该文件是一个插件，并提供有关该插件的信息。WordPress网站的顶部称为“页眉”。它包含您的徽标、主菜单、社交媒体链接、联系信息、帐户设置和搜索栏。

最小字段

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

/*
 * Plugin Name: YOUR PLUGIN NAME
 */

标头字段如何定义？

可用的标头字段：

插件名称：（必填）您的插件名称，将显示在 WordPress 管理员的插件列表中。

插件 URI：插件的主页，应为一个唯一的 URL，最好位于您自己的网站上。此 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 知道在哪里可以找到翻译。更多信息请参阅“如何国际化您的插件”页面的“域名路径”部分。

Network：插件是否只能在网络范围内激活。只能设置为true，不需要时可省略。

更新 URI：允许第三方插件避免被 WordPress.org 插件目录中同名插件的更新意外覆盖。更多信息，请阅读相关的开发者说明。

需要插件：以逗号分隔的 WordPress.org 格式的依赖项 slug 列表，例如 my-plugin (my-plugin/my-plugin.php 不支持)。插件 slug 中不支持逗号。更多信息，请参阅相关的开发者说明。

带有标头注释的有效 PHP 文件可能如下所示：

/*

* Plugin Name:       My Basics Plugin

* Plugin URI:        https://hao-blog.com/

* 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://hao-blog.com/

* License:           GPL v2 or later

* License URI:       https://www.gnu.org/licenses/gpl-2.0.html

* Update URI:        https://hao-blog.com/

* 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://hao-blog.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://hao-blog.com/

* Text Domain:       plugin-slug

* License:           GPL v2 or later

* License URI:       http://www.gnu.org/licenses/gpl-2.0.txt

* Update URI:        https://hao-blog.com/

* Requires Plugins:  my-plugin, yet-another-plugin

*/

笔记

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