README

WordPress PHP library for plugin updates from GitHub releases: uses the latest release tag as the version and the release ZIP (or zipball) as the package.

Requirements: PHP 7.4+, WordPress 5.0+

Installation

composer require ernilambar/gitvise

In your plugin, load the library via its entry point:

require_once __DIR__ . '/vendor/ernilambar/gitvise/init.php';

Usage

use Nilambar\Gitvise\Updater;

$updater = new Updater( 'your-github-user/your-repo-name', __FILE__ );
$updater->init();

Optional: Third argument = custom update slug (when plugin dir name differs from desired slug). Fourth argument = GitHub personal access token (for higher API rate limit).

$updater = new Updater( 'user/repo', __FILE__, 'repo-slug', 'ghp_your_token' );
$updater->init();

How it works

On each update check, the library fetches the latest release from the GitHub API, compares the tag (e.g. v1.2.3 → 1.2.3) with the installed version from WordPress’s transient, and populates the update with the first ZIP asset or the zipball URL. The plugins_api filter is handled so “View details” shows release info.

License

MIT. See LICENSE.