Documentation

Forwarding
in package
Uses UtilsProvider

Handle consent forwarding REST services.

Table of Contents

Constants

ENDPOINT_CONSENT_FORWARD  = 'consent/forward'

Methods

getPluginConstantPrefix()  : string
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
instance()  : mixed
New instance.
permission_callback()  : mixed
Check if user is allowed to call this service requests.
rest_api_init()  : mixed
Register endpoints.
routeGetEndpoints()  : mixed
See API docs.
routeGetUniqueCookie()  : mixed
See API docs.
routePost()  : mixed
See API docs.
__construct()  : mixed
C'tor.

Constants

public mixed ENDPOINT_CONSENT_FORWARD = 'consent/forward'

Methods

getPluginConstantPrefix()

Get the prefix of this plugin so composer packages can dynamically build other constant values on it.

public getPluginConstantPrefix() : string
Tags
codeCoverageIgnore

It only returns a string with the constant prefix

Return values
string

instance()

New instance.

public static instance() : mixed

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

routeGetEndpoints()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string='all','onlyCurrent','notCurrent'} [filter=all]

apiName

ForwardEndpointsGet

apiGroup

Config

apiPermission

manage_options, Pro only

apiVersion

1.0.0

routeGetUniqueCookie()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string} slug

apiName

ForwardCookieUniqueGet

apiGroup

Config

apiPermission

manage_options, Pro only

apiVersion

1.0.0

routePost()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string[]} cookies Unique, mappable names of all accepted cookies

apiParam

{string} uuid The UUID to use

apiParam

{number} consentId The reference to the consent ID of the source website

apiParam

{string} buttonClicked

apiParam

{number} [viewPortWidth=0]

apiParam

{number} [viewPortHeight=0]

apiParam

{boolean} [blocker]

apiParam

{string} [tcfString]

apiParam

{array} [gcmConsent]

apiName

Forward

apiGroup

Consent

apiPermission

Pro only

apiVersion

1.0.0

__construct()

C'tor.

private __construct() : mixed

        
On this page

Search results