Kindly EditDocumentationTry the editor

popups/{id}/status REST endpoint

Manage popup records, their publication status, settings schema, or public event statistics.

Endpoint#

Manage popup records, their publication status, settings schema, or public event statistics.

/wp-json/cantata-edit/v1/popups/(?P<id>\d+)/status

Named regular-expression groups in this registered route are path parameters. Replace them with an actual matching value when constructing a request.

POST#

This operation uses a server permission callback. Browser clients need an authenticated WordPress session and REST nonce. The server checks the relevant caller capability and feature gates.

Permission function: cantata_edit_can_popups.

Registered argument schema#

{
  "on": {
    "type": "boolean",
    "required": true
  }
}

WordPress applies these registered field rules before the callback. Feature-specific validation can add further constraints.

Callback input keys#

id, on. This literal-key inventory supplements the registered schema; nested objects and downstream validators can define additional structure.

Implementation#

Client handling#

Use HTTPS on production sites. Treat authentication failures, validation errors, missing records, and stale-revision conflicts as different outcomes. Read the returned WordPress error code and message. Before retrying a timed-out mutation, determine whether the first request succeeded. Prefer the documented higher-level editor or Ability workflow when an endpoint coordinates several metadata owners.

About this page

Documents Kindly Edit 0.9.16. Source: includes/popups.php:26, includes/popups.php:809. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.