makeweb/updater

该软件包最新版本(1.2.4)没有可用的许可信息。

1.2.4 2018-09-19 08:24 UTC

This package is not auto-updated.

Last update: 2024-09-29 02:39:26 UTC


README

将您的插件连接到运行Easy Digital Downloads - 软件许可的服务器

安装

可以通过以下方式使用composer进行安装:

composer require makeweb/updater

使用方法

使用composer自动加载包

如果您还没有通过require composer自动加载器来自动加载包的类,请确保这样做。您的主插件文件通常是最好放置require composer自动加载器的地方。您只需在插件中这样做一次。

// Autoload composer dependencies
require __DIR__.'/vendor/autoload.php';

启动更新器

在主插件文件中启动上传器

// Boot the plugin update client
(new MakeWeb\Updater\Updater(__FILE__))->boot();

您也可以在任何其他文件中实现这一点,但请确保将主插件文件的完整路径传递给Updater构造函数,而不是使用__FILE__。

配置

更新客户端从主插件文件中提取所有必要的配置,从主插件文件的头部注释和文件名中获取。

例如,考虑以下头部注释块

/*
Plugin Name: MyCompany Thingamajiggy
Description: Respiculate your stultiloquence
Version: 1.0.0
Author: MyCompany
Author URI: http://example.org
*/

该软件包将在example.org查找更新服务器,并尝试根据给定的插件名称和版本查找可用的更新。

WordPress设置页面

该软件包将自动在“插件”菜单下创建一个名为{MyCompany} Plugin Licenses的设置页面,其中{MyCompany}的值来自主插件文件的“Author”头部。如果安装了多个使用此软件包的插件,具有相同Author名称的插件将出现在同一页面上。每个插件都有一个文本输入字段,可以输入许可证密钥,允许用户使用更新服务器上的更新更新他们的插件。