Download the PHP package pfaciana/wp-update-checker without Composer

On this page you can find all versions of the php package pfaciana/wp-update-checker. 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 pfaciana/wp-update-checker

Informations about the package wp-update-checker

Project Update Checker

Overview

This is a WordPress plugin that will manage updates for your custom WordPress plugins or themes that are hosted on external repositories such as GitHub and GitLab. This is an alternative option to having your theme or plugin hosted on WordPress.org. Right now this only supports GitHub and GitLab repositories out of the box, more may come, but you can create your own custom option for any platform by extending the \PackageUpgrader\V1\Context\AbstractRemote class from this project in your code.

How to use

This plugin is designed to be easy to use. Its configuration is done using your existing plugin/theme metadata comments already defined in your plugin or theme's main file, with a couple extra metadata comments for where to find the source repo.

Step 1

Install via composer packagist

NOTE: Alternative option, you can download the package as a standalone plugin alongside your plugin or theme. To do this, go to https://github.com/pfaciana/wp-update-checker/releases and download the Release Asset named wp-update-checker.zip from the lasted release. Then go to your WordPress admin and choose Plugin > Add New Plugin from the side menu and upload the wp-update-checker.zip and click Install Now.

Both options will work, but using composer and bundling it inside your plugin/theme is recommended.

Step 2

Init the PackageUpgrader Plugin or Theme instance in your code...

Place this code in the root of your plugin or theme. It will automatically find your plugin/theme's main file if it's in the same directory. If it's not, then you'll have to pass the location of the main file of your plugin/theme to tell the update checker where to find your plugin/theme.

Step 3

Add in the necessary WordPress comments into your plugin or theme's main file. For example,

Most of these metadata comments you'll already have in your plugin/theme's main file. It supports all the WordPress metadata comments (like Plugin/Theme Name, Plugin/Theme URI, Version, Description, Author, Author URI, Requires at least, Requires PHP, Compatible up to, Tags, etc) and will use them in the plugin/theme dialog overlay. It also supports most of the WordPress plugin/theme api status fields (like Homepage, Donate Link, Active Installs, etc) from the plugins_api/themes_api filter hooks. You can also have your own code hook into these as well.

In addition to the standard WordPress metadata comments, it also supports a few custom metadata comments to help find the source repo. The only required one is the GitHub URI or GitLab URI metadata comment. This is your username (or organization name) and repository name, as defined in the repo's url. The rest are optional. Release Asset and Remote File are only used if you have a special build process that creates your plugin/theme. If your build creates a release asset that should be used instead of the default source code zip, use the Release Asset key. If your build process dynamically creates the main plugin/theme file (which means it does not exist in the source code of the repo) use Remote File to define which file in your repo has the metadata comments. You can enter a json file here, and it will look for the extra.wordpress key and parse that as the metadata comments.

This plugin's custom metadata comments

Header Comment Description Example Value
GitHub URI GitHub repository identifier owner/repo
GitLab URI GitLab repository identifier owner/repo
Remote Visibility If the plugin or theme is private and needs an api token to access remote data public (default), private
Primary Branch Primary branch name master (default)
Release Asset Relative URL to the zip file for download wp-plugin.zip (defaults to release source zip)
Remote File The relative file path to the plugin or theme file that has the header comments index.php (defaults to main file)

Composer Smart Autoloader

This projects also comes with Composer Smart Autoloader installed as a dependency, but in order to take advantage of it you'll need to init it in your own code like this:

For more details on what Composer Smart Autoloader is and how to use it, see Composer Smart Autoloader.

All versions of wp-update-checker with dependencies

PHP Build Version
Package Version
Requires erusev/parsedown Version ^1.7
pfaciana/composer-smart-autoloader Version ^1
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 pfaciana/wp-update-checker contains the following files

Loading the files please wait ....