wordpress插件开发手册-插件头header

2023-08-22 12:25:19
723
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。
  • 许可证：插件许可证的短名称（slug）（例如 GPLv2）。有关许可的更多信息，请参阅 WordPress.org 指南。
  • 许可证 URI：指向许可证全文的链接（例如 https://www.gnu.org/licenses/gpl-2.0.html）。
  • 文本域：插件的获取文本域。更多信息可以在如何国际化插件页面的文本域部分找到。
  • 域路径：域路径让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/
 */