在 WordPress 开发中,插件和主题的自动更新是一个非常重要的功能。官方 WordPress 仓库中的插件和主题可以轻松实现自动更新,但如果你的插件或主题是商业的、私有的,或者因为其他原因无法发布到官方仓库,那么如何实现自动更新呢?
yahnis-elsts/plugin-update-checker就是为了解决这个问题而生的。它是一个自定义更新检查器库,可以让你轻松地为你的 WordPress 插件和主题添加自动更新功能。
核心原理
yahnis-elsts/plugin-update-checker的核心原理是:
- 信息存储: 将你的插件或主题的更新信息(如版本号、下载链接等)存储在一个 JSON 文件中。
- URL 提供: 将这个 JSON 文件上传到你的服务器,并提供一个公开可访问的 URL。
-
定期检查: 在你的插件或主题代码中使用
yahnis-elsts/plugin-update-checker
,并告诉它 JSON 文件的 URL。它会定期检查该 URL,查看是否有新版本可用。 - 更新通知: 如果有新版本可用,它会像官方插件一样,在 WordPress 后台显示更新通知。
使用方法
-
安装: 使用 Composer 安装
yahnis-elsts/plugin-update-checker
:composer require yahnis-elsts/plugin-update-checker
-
创建 JSON 文件: 根据你的插件或主题,创建一个包含更新信息的 JSON 文件。例如,一个插件的 JSON 文件可能如下所示:
{ "name": "My Awesome Plugin", "version": "1.2.0", "download_url": "https://example.com/my-awesome-plugin-1.2.0.zip", "sections": { "description": "This is a description of my awesome plugin." } } 上传 JSON 文件: 将 JSON 文件上传到你的服务器,并确保可以通过 URL 访问。
-
初始化更新检查器: 在你的插件或主题代码中,初始化
yahnis-elsts/plugin-update-checker
:require 'plugin-update-checker/plugin-update-checker.php'; use YahnisElsts\PluginUpdateChecker\v5\PucFactory; $myUpdateChecker = PucFactory::buildUpdateChecker( 'https://example.com/path/to/details.json', __FILE__, 'my-awesome-plugin' );'https://example.com/path/to/details.json'
:你的 JSON 文件的 URL。__FILE__
:你的插件或主题的主文件路径。'my-awesome-plugin'
:你的插件或主题的 slug。
优势
- 简单易用: 只需要几行代码就可以集成到你的插件或主题中。
- 灵活可配置: 支持多种更新源,如自托管服务器、GitHub、BitBucket、GitLab 等。
- 用户体验好: 使用 WordPress 默认的更新 UI,用户无需学习新的更新流程。
- 免费开源: 免费使用,并提供开源代码,方便你进行自定义和扩展。
实际应用效果
使用
yahnis-elsts/plugin-update-checker后,你的插件或主题可以拥有像官方插件一样的自动更新体验。用户可以在 WordPress 后台轻松地获取更新通知,并一键升级到最新版本,大大提高了用户体验和插件的易用性。同时,也减少了你手动通知用户更新的麻烦。
总而言之,
yahnis-elsts/plugin-update-checker是一个非常实用的 WordPress 插件和主题自动更新解决方案,可以帮助你轻松地为你的产品添加自动更新功能,提高用户体验,并减少维护成本。如果你正在开发 WordPress 插件或主题,并且需要自动更新功能,那么不妨尝试一下
yahnis-elsts/plugin-update-checker。










