Documentation

Reset
in package
Uses UtilsProvider

Enables the /reset, /import and /export REST for admins (manage_options).

Table of Contents

Methods

export()  : WP_REST_Response|WP_Error
See API docs.
getPluginConstantPrefix()  : string
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
import()  : WP_REST_Response|WP_Error
See API docs.
importFileBird()  : WP_REST_Response|WP_Error
See API docs.
importMlf()  : WP_REST_Response|WP_Error
See API docs.
importTaxonomy()  : WP_REST_Response|WP_Error
See API docs.
permission_callback()  : mixed
Check if user is allowed to call this service requests.
permission_callback_activate_plugins()  : mixed
Check if user is allowed to call this service requests.
resetCount()  : WP_REST_Response|WP_Error
See API docs.
resetDebug()  : WP_REST_Response|WP_Error
See API docs.
resetFolders()  : WP_REST_Response|WP_Error
See API docs.
resetOrder()  : WP_REST_Response|WP_Error
See API docs.
resetRelations()  : WP_REST_Response|WP_Error
See API docs.
resetSlugs()  : WP_REST_Response|WP_Error
See API docs.
rest_api_init()  : mixed
Register endpoints.
routeNoticeDismissImportTax()  : WP_REST_Response|WP_Error
See API docs.
routeNoticeDismissLite()  : WP_REST_Response|WP_Error
See API docs.

Methods

export()

See API docs.

public export(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiName

Export

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

Return values
WP_REST_Response|WP_Error

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

import()

See API docs.

public import(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiParam

{string} import The JSON import string

apiName

Import

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

apiPermission

Pro only

Return values
WP_REST_Response|WP_Error

importFileBird()

See API docs.

public importFileBird(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
since
4.8.0
apiName

ImportMlf

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

apiPermission

Pro only

Return values
WP_REST_Response|WP_Error

importMlf()

See API docs.

public importMlf(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
since
4.8.0
apiName

ImportMlf

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

apiPermission

Pro only

Return values
WP_REST_Response|WP_Error

importTaxonomy()

See API docs.

public importTaxonomy(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiParam

{string} taxonomy The taxonomy name

apiName

ImportTaxonomy

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

apiPermission

Pro only

Return values
WP_REST_Response|WP_Error

permission_callback()

Check if user is allowed to call this service requests.

public permission_callback() : mixed

permission_callback_activate_plugins()

Check if user is allowed to call this service requests.

public permission_callback_activate_plugins() : mixed

resetCount()

See API docs.

public resetCount(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiName

ResetCount

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

Return values
WP_REST_Response|WP_Error

resetDebug()

See API docs.

public resetDebug(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiName

ResetDebug

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

Return values
WP_REST_Response|WP_Error

resetFolders()

See API docs.

public resetFolders(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiName

ResetFolders

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

Return values
WP_REST_Response|WP_Error

resetOrder()

See API docs.

public resetOrder(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiName

ResetOrder

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

apiPermission

Pro only

Return values
WP_REST_Response|WP_Error

resetRelations()

See API docs.

public resetRelations(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiName

ResetRelations

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

Return values
WP_REST_Response|WP_Error

resetSlugs()

See API docs.

public resetSlugs(WP_REST_Request $request) : WP_REST_Response|WP_Error
APIYes
Parameters
$request : WP_REST_Request
Tags
apiName

ResetSlugs

apiGroup

Reset

apiVersion

1.0.0

apiPermission

manage_options

Return values
WP_REST_Response|WP_Error

rest_api_init()

Register endpoints.

public rest_api_init() : mixed

routeNoticeDismissImportTax()

See API docs.

public routeNoticeDismissImportTax() : WP_REST_Response|WP_Error
APIYes
Tags
since
4.6.2
apiName

DismissImportTaxNotice

apiGroup

Plugin

apiVersion

4.6.2

apiPermission

activate_plugins

Return values
WP_REST_Response|WP_Error

routeNoticeDismissLite()

See API docs.

public routeNoticeDismissLite() : WP_REST_Response|WP_Error
APIYes
Tags
since
4.6.0
apiName

DismissLiteNotice

apiGroup

Plugin

apiVersion

4.6.0

apiPermission

activate_plugins

Return values
WP_REST_Response|WP_Error

        
On this page

Search results