README

此WordPress插件将在WP管理后台提供一个接口，用于保存外部Open Data作为WordPress Transients，并提供一个开发者API来与之交互。您可以在Codex中了解更多关于WordPress Transients API的信息。

功能

• 管理界面（设置 > Open Data Transients）用于添加新的transients和添加Open Data令牌。
• 可以在管理界面中手动更新transients，但它们默认每周过期（使用WordPress常量WEEK_IN_SECONDS）。
• 开发者API用于获取transient数据，并在其过期时自动更新。

使用方法

安装

它使用composer/installers直接通过Composer将其安装到插件中。只需运行：

composer require nyco/wp-open-data-transients

您也可以下载此包并将其手动添加到您的插件目录中。

应用令牌

令牌将通过头部（X-App-Token）发送到Open Data端点，以验证您的应用程序以保存数据。这可以在同一管理界面中设置，也可以作为环境变量$_ENV['OPEN_DATA_APP_TOKEN']。可以使用NYCO WP Config插件来管理环境变量。

已保存的Transients

可以通过添加有效的名称（只包含字母和下划线）和有效的URL来保存transients。点击“保存Transient”将保存transient并缓存请求。一旦保存，就可以使用开发者API获取数据。开发者API还公开了管理界面使用的保存和设置方法。

输入已保存的transient的名称并点击“保存Transient”将更新transient数据缓存。

开发者API

一旦安装了插件，您就可以引用命名空间来使用它；

use NYCO\Transients as Transients;

保存

在将其暴露给set或get方法之前，必须使用有效的名称（只包含字母和下划线）和有效的URL来保存transient。

Transients::save('your_transient_name', 'https://opendata.com/endpoint');

设置

使用WordPress的wp_remote_get和set_transient方法检索保存的端点并将响应体保存。它将期望一个JSON响应并将其保存为PHP对象。

Transients::set('your_transient_name');

获取

返回一个保存的transient。如果transient为空（已过期），它将使用set方法重新缓存它。

Transients::get('your_transient_name');

潜在改进

此插件仅提供将外部Open Data保存为WordPress Transients和外部数据的小型接口，并且不是一个完整的transient管理器。

• 删除已保存的transients的方法。
• 设置transients过期选项。

关于NYCO

NYC Opportunity是纽约市经济机会市长办公室。我们致力于分享我们产品中使用的开源软件。请随时提问和分享反馈。关注@nycopportunity在Github、Twitter、Facebook和Instagram。