WordPress插件头注释申明

Author: 陌小雨Date: 2024-12-20View: 126

如《入门指南》中所述,主PHP文件应包含标题注释,这些注释告诉WordPress文件是插件,并提供有关插件的信息。

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

/**
 * Plugin Name: YOUR PLUGIN NAME
 */

头字段#标头字段
可用的标题字段:

插件名称:(必需的)你的插件,它会显示在WordPress管理的插件列表的名称。
插件URI:插件的主页,应该是唯一的URL,最好在您自己的网站上。这对于您的插件必须是唯一的。您不能在此处使用WordPress.org URL。
描述:插件的简短描述,如WordPress Admin的“插件”部分中所示。将此说明的字符数少于140个。
版本:插件的当前版本号,例如1.0或1.0.3。
至少需要:该插件可以使用的最低WordPress版本。
需要PHP:所需的最低PHP版本。
作者:插件作者的姓名。可能使用逗号列出多个作者。
作者URI:作者的网站或其他网站上的个人资料,例如WordPress.org。
许可证:插件许可证(例如GPLv2)的简称。有关许可的更多信息,请参见WordPress.org指南。
许可证URI:指向许可证全文的链接(例如https://www.gnu.org/licenses/gpl-2.0.html)。
文本域:插件的gettext文本域。有关更多信息,请参见“如何国际化插件”页面的“文本域”部分。
域路径:域路径使WordPress知道在哪里可以找到翻译。有关更多信息,请参见如何国际化插件页面的“域路径”部分。
网络:插件是否只能在整个网络范围内激活。只能设置为true,并且在不需要时应省略。
具有标题注释的有效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
 * 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
 */

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