Download the PHP package soderlind/wordpress-github-updater without Composer

On this page you can find all versions of the php package soderlind/wordpress-github-updater. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of soderlind/wordpress-github-updater

Informations about the package wordpress-github-updater

WordPress Plugin GitHub Updater

Composer library for handling WordPress plugin updates from GitHub repositories. Built on yahnis-elsts/plugin-update-checker with built-in rate-limit mitigation.

Features

Installation

This automatically includes yahnis-elsts/plugin-update-checker as a dependency.

Requirements

Quick Start

Positional equivalent:

With GitHub Token (for private repos or higher rate limits)

Backward Compatibility API

GitHub_Plugin_Updater is still available for existing integrations.

Configuration

GitHubUpdater::init(...)

Parameter Required Default Description
github_url Yes - Full repository URL (https://github.com/owner/repo)
plugin_file Yes - Absolute path to the main plugin file
plugin_slug Yes - Plugin slug used by WordPress
name_regex No '' Regex to match release asset zip filename
branch No 'main' Branch to track
check_period No 6 Hours between update checks. Set to 0 to disable automatic checks.
auth_token No '' GitHub personal access token for private repos or higher rate limits

Rate-Limit Mitigation

This library includes built-in protection against GitHub API timeouts/overload:

  1. Configurable check interval: Default is 6 hours (vs. upstream default of 12h). Adjust via check_period.
  2. Throttled checks: When an update is already known, checks are reduced to every 72 hours.
  3. Token authentication: Provide a GitHub token to increase rate limits from 60 to 5000 requests/hour.
  4. Error logging: API errors are logged when WP_DEBUG is enabled.

Recommended Integration Pattern

From your main plugin file:

Workflow Templates

This repository includes two workflow templates in .github/workflows/:

Copy them into your plugin repository at .github/workflows/.

Workflow Checklist

  1. Set PLUGIN_ZIP to your plugin zip file (example: my-plugin.zip).
  2. Keep composer install --no-dev --optimize-autoloader so dependencies are packaged.
  3. Keep the verification step that checks vendor/yahnis-elsts/plugin-update-checker exists in the zip.
  4. Ensure name_regex in PHP matches your zip filename convention.

Troubleshooting

Updates do not appear

  1. Confirm your plugin file, slug, repo URL, and branch are correct.
  2. Publish a release with an attached zip that matches name_regex.
  3. Trigger a manual update check in WordPress Admin (or wait for scheduled checks).

Dependency is missing in release zip

If plugin-update-checker is not in vendor/, updater setup fails. In WP_DEBUG, you will see:

GitHubUpdater (your-plugin-slug): Missing dependency yahnis-elsts/plugin-update-checker...

GitHub API rate limits

The library includes built-in rate-limit mitigation:

If you still hit rate limits, increase check_period or add a GitHub token.

Private repositories

Pass your GitHub personal access token via the auth_token parameter:

Real-World Reference

WordPress plugins at https://github.com/soderlind

License

GPL-2.0-or-later.

All versions of wordpress-github-updater with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
yahnis-elsts/plugin-update-checker Version ^5.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package soderlind/wordpress-github-updater contains the following files

Loading the files please wait ...