Documentation

Consent
in package
uses UtilsProvider

Consent API

Table of Contents

Constants

CONSENT_ALL_ITEMS_PER_PAGE  : mixed = 10

Methods

application_password_is_api_request()  : mixed
Public Real Cookie Banner REST endpoints must stay anonymous: no login and no Application Password auth. Application Passwords reuse HTTP Basic Auth, so directory protection (Plesk, Traefik) looks like a failed login (`invalid_username`) and Core would 401 these visitor routes.
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.
routeDelete()  : mixed
See API docs.
routeDeleteAll()  : mixed
See API docs.
routeDeleteClear()  : mixed
See API docs.
routeGet()  : mixed
See API docs.
routeGetAll()  : mixed
See API docs.
routeGetAllReferer()  : mixed
See API docs.
routePost()  : mixed
See API docs.
routePostDynamicPredecision()  : mixed
See API docs.
isAnonymousConsentRestRoute()  : mixed
Visitor-facing consent routes (`permission_callback` is `__return_true`).
__construct()  : mixed
C'tor.

Constants

CONSENT_ALL_ITEMS_PER_PAGE

public mixed CONSENT_ALL_ITEMS_PER_PAGE = 10

Methods

application_password_is_api_request()

Public Real Cookie Banner REST endpoints must stay anonymous: no login and no Application Password auth. Application Passwords reuse HTTP Basic Auth, so directory protection (Plesk, Traefik) looks like a failed login (`invalid_username`) and Core would 401 these visitor routes.

public application_password_is_api_request(bool $isApiRequest) : mixed

That conflicts with the consent check loopback (SavingConsentViaRestApiEndpointChecker), which must forward directory-protection Basic Auth so the dummy POST reaches /consent behind Traefik/Plesk — without this filter the check reports a false-positive failure.

Parameters
$isApiRequest : bool
Tags
see
https://developer.wordpress.org/reference/hooks/application_password_is_api_request/
https://developer.wordpress.org/reference/functions/wp_authenticate_application_password/
https://developer.wordpress.org/reference/functions/wp_validate_application_password/

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

routeDelete()

See API docs.

public routeDelete(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiName

Delete

apiGroup

Consent

apiVersion

1.0.0

routeDeleteAll()

See API docs.

public routeDeleteAll() : mixed
APIYes
Tags
apiHeader

{string} X-WP-Nonce

apiName

DeleteAll

apiGroup

Consent

apiVersion

1.0.0

apiPermission

manage_options

routeDeleteClear()

See API docs.

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

{string} X-WP-Nonce

apiParam

{string} cookies A comma separated list of cookie ids which should be opt-out

apiName

DeleteClear

apiGroup

Consent

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

apiName

Get

apiGroup

Consent

apiVersion

1.0.0

routeGetAll()

See API docs.

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

{string} X-WP-Nonce

apiParam

{number} offset

{number} [per_page=10]

{string} [uuid]

{string} [ip]

{string} [referer]

{string} [from] From date in format YYYY-MM-DD

{string} [to] From date in format YYYY-MM-DD

{string} [context]

{string} [migration] Allows to start a migration process (e.g. when switching from RCB v4 to v5)

apiName

GetAll

apiGroup

Consent

apiVersion

1.0.0

apiPermission

manage_options

routeGetAllReferer()

See API docs.

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

{string} X-WP-Nonce

apiName

GetAllReferer

apiGroup

Consent

apiVersion

1.0.0

apiPermission

manage_options

routePost()

See API docs.

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

{array} decision

{string} buttonClicked

{boolean} [dummy]

{boolean} [markAsDoNotTrack]

{number} [viewPortWidth=0]

{number} [viewPortHeight=0]

{number} [blocker=0]

{string} [blockerThumbnail]

{string} [tcfString]

{array} [gcmConsent]

{string} [recorderJsonString]

{string} [uiView]

{string} [createdClientTime]

{string} [setCookies=true]

{string} [referer]

apiName

Create

apiGroup

Consent

apiVersion

1.0.0

routePostDynamicPredecision()

See API docs.

public routePostDynamicPredecision(WP_REST_Request $request) : mixed
APIYes
Parameters
$request : WP_REST_Request
Tags
apiParam

{number} [viewPortWidth=0]

{number} [viewPortHeight=0]

{string} [tcfStringImplicitEssentials]

apiName

CalculateDynamicPredecision

apiGroup

Consent

apiVersion

1.0.0

isAnonymousConsentRestRoute()

Visitor-facing consent routes (`permission_callback` is `__return_true`).

protected isAnonymousConsentRestRoute() : mixed

determine_current_user runs before rest_route is filled, so fall back to REQUEST_URI.

__construct()

C'tor.

private __construct() : mixed
On this page

Search results