wp-launchpad/options

此包的最新版本(v0.1.5)没有可用的许可证信息。

Launchpad 选项库

v0.1.5 2024-07-22 14:57 UTC

README

此库提供了面向对象的门面来处理 WordPress 中的选项和短暂数据。

安装

只需运行命令 composer require wp-launchpad/options

注意:使用 Launchpad 框架 与该库一起工作更为容易。

选项

选项是保存简单轻量值的一种方式。

要使用该库中的选项,首先需要实例化类并提供一个前缀

$options = new \LaunchpadOptions\Options('my_prefix');

注意:按照惯例,您的前缀应该是您的插件或主题名称。

完成此操作后,您可以直接使用以下 API 访问、更新或删除选项

网站选项

网站选项是保存简单轻量值的一种方式,就像常规选项一样。然而,主要区别在于在多站点的情况下,它将在网站级别而不是网络级别存在。

要使用该库中的选项,首先需要实例化类并提供一个前缀

$options = new \LaunchpadOptions\SiteOptions('my_prefix');

注意:按照惯例,您的前缀应该是您的插件或主题名称。

完成此操作后,您可以直接使用以下 API 访问、更新或删除选项

短暂数据

短暂数据是保存简单轻量值的一种方式,但与选项不同的是,它们会在一定时间后过期。

要使用该库中的短暂数据,首先需要实例化类并提供一个前缀

$transients = new \LaunchpadOptions\Transients('my_prefix');

注意:按照惯例,您的前缀应该是您的插件或主题名称。

完成此操作后,您可以直接使用以下 API 访问、更新或删除短暂数据

设置

设置是轻松保存插件或主题配置的一种方式。

与选项相比的优势在于可以批量更新它们或一次性导出它们。

要使用该库中的设置,首先需要实例化类并提供一个前缀

$settings = new \LaunchpadOptions\Settings(new \LaunchpadOptions\Options('my_prefix'), 'my_settings_prefix');

注意:按照惯例,您的前缀应该是您的插件或主题名称。

完成此操作后,您可以直接使用以下 API 访问、更新或删除设置

设置

集合是轻松交互来自选项的数组数据的一种方式。

要使用该库中的集合,首先需要实例化类并提供一个前缀

$set = new \LaunchpadOptions\Set([
    'key' => 'value'
], 'my_prefix');

注意:前缀实际上对类内的过滤器非常重要。

完成此操作后,您可以直接使用以下 API 访问、更新或删除集合中的值

注意:设置和集合之间的主要区别是设置在数据库中自行保存,而集合则不会。