Documentation

PluginUpdate
in package
Uses UtilsProvider

Create plugin update REST service.

Table of Contents

Methods

getPluginConstantPrefix()  : string
Get the prefix of this package so we can utils package natively.
instance()  : mixed
New instance.
permission_callback()  : mixed
Check if user is allowed to call this service requests.
rest_api_init()  : mixed
Register endpoints.
routeDeleteLicense()  : mixed
See API docs.
routeDismissLicenseNotice()  : mixed
See API docs.
routeGet()  : mixed
See API docs.
routePatch()  : mixed
See API docs.
routeRetryLicense()  : mixed
See API docs.
routeSkip()  : mixed
See API docs.
routeTelemetry()  : mixed
See API docs.
setupConstants()  : mixed
Make sure the RPM_WP_CLIENT constants are available.
getResult()  : mixed
Get result for a given slug.
__construct()  : mixed
C'tor.

Methods

getPluginConstantPrefix()

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

public getPluginConstantPrefix() : string
Return values
string

instance()

New instance.

public static instance() : mixed
Tags
codeCoverageIgnore

permission_callback()

Check if user is allowed to call this service requests.

public permission_callback() : mixed

rest_api_init()

Register endpoints.

public rest_api_init() : mixed

routeDeleteLicense()

See API docs.

public routeDeleteLicense(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiHeader

{string} X-WP-Nonce

apiParam

{string} slug

apiParam

{number} blogId

apiName

DeleteLicense

apiPermission

activate_plugins

apiGroup

PluginUpdate

apiVersion

1.0.0

routeDismissLicenseNotice()

See API docs.

public routeDismissLicenseNotice(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiHeader

{string} X-WP-Nonce

apiParam

{string} slug

apiName

DeleteLicenseNotice

apiPermission

activate_plugins

apiGroup

PluginUpdate

apiVersion

1.0.0

routeGet()

See API docs.

public routeGet(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiHeader

{string} X-WP-Nonce

apiParam

{string} slug

apiName

GetPluginUpdate

apiPermission

activate_plugins

apiGroup

PluginUpdate

apiVersion

1.0.0

routePatch()

See API docs.

public routePatch(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiHeader

{string} X-WP-Nonce

apiParam

{string} slug

apiParam

{string} licenses JSON string: Array<{ blog: number; installationType: "development" | "production"; code: string; }>

apiParam

{boolean} terms

apiParam

{boolean} [telemetry]

apiParam

{boolean} [newsletter]

apiParam

{string} [firstName]

apiParam

{string} [email]

apiName

PatchPluginUpdate

apiPermission

activate_plugins

apiGroup

PluginUpdate

apiVersion

1.0.0

routeRetryLicense()

See API docs.

public routeRetryLicense(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiHeader

{string} X-WP-Nonce

apiParam

{string} slug

apiParam

{number} blogId

apiName

RetryLicense

apiPermission

activate_plugins

apiGroup

PluginUpdate

apiVersion

1.0.0

routeSkip()

See API docs.

public routeSkip(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiHeader

{string} X-WP-Nonce

apiParam

{string} slug

apiName

SkipPluginUpdate

apiPermission

activate_plugins

apiGroup

PluginUpdate

apiVersion

1.0.0

routeTelemetry()

See API docs.

public routeTelemetry(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiHeader

{string} X-WP-Nonce

apiParam

{string} slug

apiParam

{number} blogId

apiName

GetTelemetry

apiPermission

activate_plugins

apiGroup

Telemetry

apiVersion

1.0.0

setupConstants()

Make sure the RPM_WP_CLIENT constants are available.

public static setupConstants() : mixed

getResult()

Get result for a given slug.

protected getResult(string $slug) : mixed
Parameters
$slug : string

__construct()

C'tor.

private __construct() : mixed
Tags
codeCoverageIgnore 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results