Kindly EditDocumentationTry the editor

preferences REST endpoint

Save supported per-user editor preferences.

Endpoint#

Save supported per-user editor preferences.

/wp-json/cantata-edit/v1/preferences

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 expression in this release:

'permission_callback' => static fn() => cantata_edit_can_dev(), // the device canvas is part of Developer mode

Registered argument schema#

{
  "deviceCanvas": {
    "type": "boolean"
  }
}

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

Callback input keys#

deviceCanvas. 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/rest.php:92, includes/rest.php:98. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.