Documentation

PluginUpdateChecker

in package

• Application

Uses UtilsProvider

Enable external updates with the help of PUC. This should be only done in non-free plugins!

Tags

see

https://github.com/YahnisElsts/plugin-update-checker

Table of Contents

Constants

ENDPOINT  = '1.0.0/wp/product/version'

Properties

$pluginUpdate  : PluginUpdate

PluginUpdate instance.

$puc  : UpdateChecker|null

Plugin Update Checker instance.

Methods

getCheckUpdateLink()  : mixed

Generate a "Check for Updates" link so users can trigger this manually.

getLicense()  : mixed

Get the first found license as we do not differ between multiple licenses in a multisite environment. WordPress does not allow to update per-site because a plugin is installed network-wide.

getPluginConstantPrefix()  : string

Get the prefix of this package so we can utils package natively.

getPluginUpdate()  : mixed

Get plugin update instance.

getPuc()  : mixed

Get the instance of `Puc_v4_Factory`.

instance()  : mixed

New instance.

isEnabled()  : mixed

Check if Plugin Update Checker is currently active.

probablyEnableExternalUpdates()  : mixed

Enable it, probably!

queryArg()  : mixed

Add the license key to the update request.

setupConstants()  : mixed

Make sure the RPM_WP_CLIENT constants are available.

validateResult()  : mixed

The metadata JSON can also return error codes in case of license expiration / revoke.

__construct()  : mixed

C'tor.