如何为WordPress插件开发预装设置数据
在开发 WordPress 插件时,一个关键步骤是预装重要数据,确保插件从一开始就能顺利运行。以活动管理器插件为例。安装时,如果插件能自动生成一个名为 “Upcoming Events” 的页面,显示未来活动的列表,这将大有裨益。
这个预先配置好的页面嵌入了类似 [event_list number="10" scope="future" status="publish"]
这样的简码,让用户无需阅读文档就能立即利用插件的功能。
安装数据不仅在首次安装插件时有帮助,在随后更新插件时也有帮助。例如,如果更新引入了日历视图功能,插件可以自动创建一个新页面 “Events Calendar“,通过 [event_calendar status="publish"]
这样的简码来展示这一新增功能。
一般来说,数据安装的范围涵盖各种需求:
生成具有特定标题和内容的新页面。
为插件创建的自定义帖子类型(CPT)添加条目。
在 wp_options
表中插入默认设置
为用户角色分配新功能
为插件提供的新功能或更新功能向用户分配元数据(例如,用户可更改事件日期格式,并首先为所有用户添加默认值)
创建插件上下文中常用的类别,如 “conferences” 或 “sports”。
安装数据必须是一个渐进的过程,否则我们可能会创建重复的条目。
例如,如果插件 1.1 版引入了 “Upcoming Events” 页面,而用户从 1.0 版进行了更新,则只应安装与 1.1 版相关的新数据。这种增量式更新可确保在 1.2 版推出日历功能时,只添加新的 “Events Calendar” 页面,避免与 “Upcoming Events” 页面重复。
因此,在更新时,插件必须检索之前安装的版本,并只安装与新版本相对应的数据。
本文将解释如何在 WordPress 插件中安装初始数据,并在进一步更新时不断添加新数据。
提供当前版本
为了处理增量过程,插件必须跟踪其当前版本,通常在插件主文件的头文件中声明。当然,我们不能直接引用它,因为它在 PHP 注释中。因此,我们还需要在变量中定义该值,并将其提供给负责初始化和配置的 Plugin
类:
setup();
Plugin
类利用 PHP 8.0 的构造函数属性推广功能,存储了这个版本,以便我们以后引用:
<?php class Plugin { public function __construct( protected string $pluginVersion, ) {} public function setup(): void { // Initialization logic here... } // ... }
请注意,初始化和配置插件的逻辑被添加到了 setup
方法中,而不是构造函数中。这是因为构造函数必须避免产生副作用;否则,我们在扩展或组合 Plugin
类时可能会产生错误。
让我们来看看这种情况是如何发生的。假设我们最终添加了一个 BetterPlugin
类,该类由 Plugin
类的功能组成:
class BetterPlugin {
public function printSomething(): string
{
$pluginVersion = '1.0';
$plugin = new Plugin($pluginVersion);
return '' . $plugin->printSomething() . '