入门指南
简单来说,WordPress 插件是一个带有 WordPress 插件头部注释的 PHP 文件。强烈建议您创建一个目录来存放您的插件,以便将所有插件文件整齐地组织在一个地方。
要开始创建新插件,请按照以下步骤操作。
- 导航到 WordPress 安装的 wp-content 目录。
- 打开 plugins 目录。
- 创建一个新目录并将其命名为插件名称(例如
plugin-name)。 - 打开新插件的目录。
- 创建一个新的 PHP 文件(最好也将此文件命名为您的插件名称,例如
plugin-name.php)。
以下是 Unix 命令行中的操作过程:
wordpress $ cd wp-content
wp-content $ cd plugins
plugins $ mkdir plugin-name
plugins $ cd plugin-name
plugin-name $ vi plugin-name.php在上面的示例中,vi 是文本编辑器的名称。请使用您感到舒适的任何编辑器。
现在您正在编辑新插件的 PHP 文件,您需要添加一个插件头部注释。这是一个特殊格式的 PHP 块注释,包含有关插件的元数据,例如名称、作者、版本、许可证等。插件头部注释必须符合 头部要求,至少必须包含插件的名称。
插件文件夹中只有一个 文件应包含头部注释——如果插件有多个 PHP 文件,则只有其中一个文件应包含头部注释。
保存文件后,您应该能够在 WordPress 站点中看到您的插件。登录到您的 WordPress 站点,并在 WordPress 管理器的左侧导航窗格上点击 插件。此页面显示您的 WordPress 站点拥有的所有插件的列表。您的新插件现在应该在该列表中!
钩子:动作和过滤器
WordPress 钩子允许您在特定点上接入 WordPress,以更改 WordPress 的行为,而无需编辑任何核心文件。
WordPress 中有两种类型的钩子:动作和过滤器。动作允许您添加或更改 WordPress 功能,而过滤器允许您更改加载并显示给网站用户的内容。
钩子不仅适用于插件开发人员;钩子被广泛用于由 WordPress 核心本身提供默认功能。其他钩子是未使用的占位符,仅在您需要更改 WordPress 工作方式时可供使用。这就是 WordPress 如此灵活的原因。
基本钩子
创建插件时需要的基本钩子是 register_activation_hook()、register_deactivation_hook() 和 register_uninstall_hook()。
激活钩子在您激活插件时运行。您可以使用此钩子提供一个函数来设置您的插件——例如,在 options 表中创建一些默认设置。
停用钩子在您停用插件时运行。您可以使用此钩子提供一个函数来清除您的插件存储的任何临时数据。
这些 卸载方法用于在您的插件使用 WordPress 管理界面被删除后进行清理。您可以使用此钩子删除您的插件创建的所有数据,例如添加到 options 表中的任何选项。
添加钩子
您可以使用 do_action() 添加自己的自定义钩子,这将允许开发人员通过您的钩子传递函数来扩展您的插件。
移除钩子
您还可以调用 remove_action() 来移除之前定义的函数。例如,如果您的插件是另一个插件的附加组件,您可以使用与先前插件通过 add_action() 添加的相同函数回调一起使用 remove_action() 。在这些情况下,动作的优先级很重要,因为 remove_action() 需要在初始 add_action() 之后运行。
在从钩子中移除动作以及更改优先级时应小心,因为这些更改如何影响与其他相同钩子的交互可能难以看到。我们强烈建议频繁测试。
您可以在本手册的 钩子 部分了解更多关于创建钩子和与之交互的信息。
WordPress API
您知道吗,WordPress 提供了一些 应用程序编程接口 (API)?这些 API 可以大大简化您在插件中需要编写的代码。您不想重复造轮子,尤其是当这么多人已经为您做了大量工作和测试时。
最常见的是 选项 API,它使将数据存储在数据库中以供您的插件使用变得容易。如果您考虑在插件中使用 cURL,HTTP API 可能对您感兴趣。
既然我们在谈论插件,您将想研究 插件 API。它提供了各种函数来协助您开发插件。
WordPress 如何加载插件
当 WordPress 在 WordPress 管理器的插件页面上加载已安装插件的列表时,它会搜索 plugins 文件夹(及其子文件夹)以查找带有 WordPress 插件头部注释的 PHP 文件。如果您的整个插件仅由一个 PHP 文件组成,例如 Hello Dolly,则该文件可以直接位于 plugins 文件夹的根目录中。但更常见的是,插件文件将位于以其命名的自己的文件夹中。
分享您的插件
有时您创建的插件仅用于您的站点。但许多人喜欢与 WordPress 社区的其他人分享他们的插件。在分享您的插件之前,您需要做的是 选择许可证。这让您的插件用户知道他们被允许如何使用您的代码。为了与 WordPress 核心保持兼容性,建议选择与 GNU 通用公共许可证 (GPLv2+) 兼容的许可证。