README

贡献者： Chris Reynolds
捐赠链接： https://paypal.me/jazzsequence
许可证： GPLv3
许可证URI： https://gnu.ac.cn/licenses/gpl-3.0.html

为公共GitHub仓库添加GitHub发布小部件到您的WordPress仪表板。

安装

下载zip文件，解压，并上传到您的/wp-content/plugins/目录。
通过WordPress中的“插件”菜单激活仪表板更改日志。
转到您的常规设置页面，并在/格式中添加您希望显示更新的仓库（例如jazzsequence/dashboard-changelog）。
对于私有仓库，添加GitHub个人访问令牌（PAT）以允许插件代表您获取数据。您可以在您的GitHub设置中获取PAT，或按照此官方指南进行操作。
选择是否要自动翻译更改日志。底层，翻译是通过Google翻译API免费完成的。

如何使用

默认情况下，仪表板更改日志将拉取GitHub 发布的更新，每个发布的正文内容作为每个更新的内容。为了使用，您的仓库需要使用发布。（GitHub API端点可以被修改为使用任何可用的端点，但是可能需要对拉入更新的数据进行格式化的额外自定义。）插件将拉取最近3个发布并将API数据缓存24小时。

屏幕截图

[仪表板更改日志外观.]

[常规设置中的仪表板更改日志设置.]

开发者参考

有一些过滤器钩子可用于修改插件以适应您的需求。默认情况下，此插件被构建为特别用于拉取GitHub发布，但是这可以更改为GitHub API提供的任何端点，或者可能从任何公共API拉取更新。

`dc.api_expiration`

过滤缓存过期时间。

API请求通过wp_cache_set和wp_cache_get进行过滤，因此我们尽可能少地打击API。默认情况下，API的缓存数据存储1天。您可以过滤到您喜欢的任何长度。

参数

$expire (int) 保留缓存响应代码的长度。

`dc.api.url`

API URL

默认情况下，这是 https://api.github.com/repos，专门用于仓库的GitHub API端点。如果您想使用完全不同的API，可以过滤此变量。

参数

$base_url (字符串) 要过滤的API URL。

`dc.widget.max_display`

要显示的更新数量。

默认情况下，我们从API显示3个更新（发布），但这里可以是更新。

参数

$max_display (整数) 要显示的发布更新数量。

`JSDC_REPOSITORY`

全局常量，可以用于硬编码仓库。如果已定义，则设置不在常规设置中显示。此常量可以在wp-config.php文件或其他地方定义。

`JSDC_PAT`

全局常量，可以用于硬编码个人访问令牌。如果已定义，则设置不在常规设置中显示。此常量可以在wp-config.php文件或其他地方定义。

注意：对这些字符串没有进行验证，请确保它们以正确的格式保存。

`JSDC_TRANSLATE`

全局常量，用于强制变更日志翻译。如果设置，则设置不在常规设置中显示。设置为1（启用）或0（禁用）。此常量可以在wp-config.php文件或其他地方定义。