Documentation

Import
in package
Uses UtilsProvider

Import / Export API

Table of Contents

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.
routeExport()  : mixed
See API docs.
routeExportConsents()  : mixed
See API docs.
routeImport()  : mixed
See API docs.
__construct()  : mixed
C'tor.

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

routeExport()

See API docs.

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

{string} X-WP-Nonce

apiParam

{boolean} [download=false]

apiParam

{boolean} [settings=true]

apiParam

{boolean} [cookieGroups=true]

apiParam

{boolean} [cookies=true]

apiParam

{boolean} [blocker=true]

apiParam

{boolean} [tcfVendorConfigurations=true] Since 2.0.0

apiParam

{boolean} [customizeBanner=true]

apiName

Export

apiGroup

Import

apiVersion

1.0.0

apiPermission

manage_options

routeExportConsents()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string} [uuid]

apiParam

{string} [from]

apiParam

{string} [to]

apiName

ExportConsents

apiGroup

Import

apiVersion

1.0.0

apiPermission

manage_options

routeImport()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string} json

apiParam

{boolean} cookieGroup

apiParam

{string='keep','publish','private','draft'} cookieStatus

apiParam

{string='keep','publish','private','draft'} blockerStatus

apiParam

{string='keep','publish','private','draft'} tcfVendorConfigurationStatus

apiParam

{boolean} [cookieSkipExisting=true]

apiParam

{boolean} [blockerSkipExisting=true]

apiName

Import

apiGroup

Import

apiVersion

1.0.0

apiPermission

manage_options

__construct()

C'tor.

private __construct() : mixed

        
On this page

Search results