Download the PHP package wpboilerplate/wpb-updater-checker-github without Composer

On this page you can find all versions of the php package wpboilerplate/wpb-updater-checker-github. 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 wpboilerplate/wpb-updater-checker-github

Informations about the package wpb-updater-checker-github

WPBoilerplate Updater Checker — GitHub

A Composer library that gives any GitHub-hosted WordPress plugin automatic update notifications inside the WordPress admin, using the Plugin Update Checker library.

Requirements

Internal Composer dependencies (pulled in automatically):

Package Constraint
yahnis-elsts/plugin-update-checker dev-master
automattic/jetpack-autoloader ^5.0

Installation

Add the library to the composer.json of your WordPress project or plugin:

Then install:

Make sure Composer's autoloader is loaded in your plugin or theme:

GitHub Repository Settings

The following settings must be in place on each GitHub repo you want to track:

1. Repository visibility

2. Plugin version header

The Version field in your plugin's main PHP file must be kept up to date — this is what WordPress (and the update checker) reads to decide whether an update is available:

Bump this value and push to your release branch to trigger update notifications.

3. Release branch

Decide which branch holds your stable releases (commonly main or stable). The checker watches this branch's Version header. Keep feature work on other branches and only merge to the release branch when ready.

4. GitHub Releases (optional — only if using release-assets)

If you set 'release-assets' => true, the updater will look for a ZIP file attached to a GitHub Release instead of downloading the branch archive. In that case:

Usage

Basic — single plugin

In your plugin's main file, after loading Composer's autoloader:

Private repository

Store tokens in wp-config.php as constants rather than hard-coding them:

Using GitHub Release assets

Multiple plugins via the filter

If you manage several GitHub-hosted plugins, register all of them through a single filter instead of creating multiple class instances:

Package Configuration Reference

Key Type Required Default Description
repo string Yes — Full GitHub repository URL
file_path string Yes — Absolute path to the plugin's main PHP file
name_slug string Yes — Unique plugin slug (must be unique across all registered packages)
release_branch string No 'main' Branch the updater watches for new versions
token string No '' GitHub PAT — required for private repos
release-assets bool No false When true, downloads update ZIPs from GitHub Release assets

How Updates Are Delivered

  1. You push a commit to the release branch with a bumped Version header (or publish a GitHub Release with an asset if release-assets is enabled).
  2. When an admin visits the WordPress dashboard, the Plugin Update Checker queries GitHub and compares versions.
  3. WordPress shows the standard "update available" notice on the Plugins screen.
  4. Admins can update the plugin with one click, exactly like a plugin from WordPress.org.

Troubleshooting

Symptom Likely cause Fix
No update notice after pushing a new version Version header not bumped Bump Version: in the main plugin file and push
404 / authentication errors Private repo without a token Add a valid token to the package config
Update notice but download fails Wrong file_path Ensure file_path is the absolute path to the plugin's main PHP file
Update shows but wrong ZIP downloaded release-assets mismatch Set 'release-assets' => true only if you attach ZIP assets to GitHub Releases
Updates checked too infrequently Plugin Update Checker cache Clear transients via WP-CLI: wp transient delete --all

License

GPL-2.0-or-later

All versions of wpb-updater-checker-github with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
automattic/jetpack-autoloader Version ^5.0
yahnis-elsts/plugin-update-checker Version dev-master
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 wpboilerplate/wpb-updater-checker-github contains the following files

Loading the files please wait ...