Documentation

Scanner
in package
Uses UtilsProvider

Scanner 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.
real_queue_additional_data_list()  : mixed
Add live results for the scanner tab.
real_queue_additional_data_notice()  : mixed
Add live results for the scanner results in admin bar.
rest_api_init()  : mixed
Register endpoints.
routeAddQueue()  : mixed
See API docs.
routeResultAllExternalUrlsByHost()  : mixed
See API docs.
routeResultAllExternalUrlsByTemplate()  : mixed
See API docs.
routeResultExternalUrls()  : mixed
See API docs.
routeResultIgnorePost()  : mixed
See API docs.
routeResultMarkupById()  : mixed
See API docs.
routeResultTemplates()  : 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

real_queue_additional_data_list()

Add live results for the scanner tab.

public real_queue_additional_data_list(mixed $data) : mixed
Parameters
$data : mixed

real_queue_additional_data_notice()

Add live results for the scanner results in admin bar.

public real_queue_additional_data_notice(mixed $data) : mixed
Parameters
$data : mixed

rest_api_init()

Register endpoints.

public rest_api_init() : mixed

routeAddQueue()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string[]} urls

apiParam

{boolean} [purgeUnused] If true, the difference of the previous scanned URLs gets automatically purged if they do no longer exist in the URLs (pass only if you have the complete sitemap!)

apiName

AddQueue

apiGroup

Scanner

apiVersion

1.0.0

apiPermission

manage_options

routeResultAllExternalUrlsByHost()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string} host Replace dots with underscores as some security plugins do not allow hosts in URL path

apiName

AllExternalUrlsByHost

apiGroup

Scanner

apiVersion

1.0.0

apiPermission

manage_options

routeResultAllExternalUrlsByTemplate()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string} template

apiName

AllExternalUrlsByTemplate

apiGroup

Scanner

apiVersion

1.0.0

apiPermission

manage_options

routeResultExternalUrls()

See API docs.

public routeResultExternalUrls() : mixed
APIYes
Tags
apiHeader

{string} X-WP-Nonce

apiName

ExternalUrlResults

apiGroup

Scanner

apiVersion

1.0.0

apiPermission

manage_options

routeResultIgnorePost()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string} type Can be template or host

apiParam

{string} value The host or template identifier

apiParam

{boolean} ignored

apiName

ScanResultIgnore

apiGroup

Scanner

apiVersion

1.0.0

apiPermission

manage_options

routeResultMarkupById()

See API docs.

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

{string} X-WP-Nonce

apiParam

{number} id

apiName

GetMarkup

apiGroup

Scanner

apiVersion

1.0.0

apiPermission

manage_options

routeResultTemplates()

See API docs.

public routeResultTemplates() : mixed
APIYes
Tags
apiHeader

{string} X-WP-Nonce

apiName

TemplatesResult

apiGroup

Scanner

apiVersion

1.0.0

apiPermission

manage_options

__construct()

C'tor.

private __construct() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results