An open API service indexing awesome lists of open source software.

https://github.com/x-wp/updater

WP Package Updater -Simplifies the process of updating WordPress packages from custom repositories
https://github.com/x-wp/updater

plugin-update theme-update wordpress wordpress-library wordpress-repository

Last synced: 8 months ago
JSON representation

WP Package Updater -Simplifies the process of updating WordPress packages from custom repositories

Awesome Lists containing this project

README

          

# 📦 WordPress package updater

### Simplifies the process of updating WordPress packages from custom repositories.

[![Packagist Version](https://img.shields.io/packagist/v/oblak/wp-package-updater)](https://packagist.org/packages/oblak/wp-package-updater)
![Packagist PHP Version](https://img.shields.io/packagist/dependency-v/oblak/wp-package-updater/php)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/oblakstudio/wp-package-updater)
[![Release](https://github.com/oblakstudio/wp-package-updater/actions/workflows/release.yml/badge.svg)](https://github.com/oblakstudio/wp-package-updater/actions/workflows/release.yml)

![GitHub](https://img.shields.io/github/license/oblakstudio/wp-package-updater)
![Packagist Downloads](https://img.shields.io/packagist/dm/oblak/wp-package-updater)

## Highlights
* Standardizes the process of updating plugins / themes from custom repositories.
* Fully integrates with Plugin / theme info API.
* Easily extendable / customizable

## Installation

We officially support installing via composer only

### Via composer
```bash
composer require oblak/wp-package-updater
```

## Basic Usage

```Plugin_Updater``` and ```Theme_Updater``` are the main **abstract** classes of the package, and they need to be extended in order to create an updater class.
The class is responsible for registering the plugin / theme update hooks, and for updating the plugin / theme.

At minimum you need to implement the ``get_update_url()`` method, which is responsible for returning the update info URL.

### 1. Define your updater class

```php