README

📦 WordPress包更新器

简化从自定义仓库更新WordPress包的过程。

亮点

标准化从自定义仓库更新插件/主题的过程。
完全集成到插件/主题信息API。
易于扩展/定制

安装

我们仅官方支持通过composer安装

通过composer

composer require oblak/wp-package-updater

基本用法

Plugin_Updater和Theme_Updater是包的主要抽象类，需要扩展以创建更新器类。该类负责注册插件/主题更新钩子，并更新插件/主题。

至少需要实现get_update_url()方法，该方法负责返回更新信息URL。

1. 定义您的更新器类

<?php
namespace Vendor\My_Plugin;

use Oblak\WP\Plugin_Updater;
use Oblak\WP\Theme_Updater;



class My_Plugin_Updater extends Plugin_Updater {

    protected function get_update_url() {
        return 'https://my-plugin.com/api/update';
    }

}

class My_Theme_Updater extends Theme_Updater {

    protected function get_update_url() {
        return 'https://my-theme.com/api/update';
    }

}

2. 包含自动加载文件

require_once __DIR__ . 'vendor/autoload.php';

3. 实例化更新器类

<?php

use Vendor\My_Plugin\My_Plugin_Updater;
use Vendor\My_Plugin\My_Theme_Updater;

new My_Plugin_Updater('plugin-slug');
new My_Theme_Updater('theme-slug');

高级用法

根据您的需求，您可以覆盖更新器类中的多个方法，以根据您的仓库API定制更新过程。

您可以定制的某些函数

get_headers - 返回更新请求的头部。
send_request - 向仓库API发送更新请求。
validate_response - 验证来自仓库API的响应。
get_transient_prefix - 返回插件/主题更新信息的transient前缀。

贡献

欢迎所有人的贡献。我们有一些贡献指南，以帮助您开始。

鸣谢

此项目由Oblak Studio维护。

许可证

此项目根据GNU通用公共许可证v2.0授权。

oblak / wp-package-updater

维护者

详细信息