Kindly EditDocumentationTry the editor

element-code REST endpoint

Read or draft an explicit element code owner using code-specific permissions.

Endpoint#

Read or draft an explicit element code owner using code-specific permissions.

/wp-json/cantata-edit/v1/element-code

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

GET#

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( $r ) => cantata_edit_advanced_code_permission( (int) $r['post_id'] ),

Registered argument schema#

{
  "post_id": {
    "type": "integer",
    "required": true
  }
}

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

Callback input keys#

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

Implementation#

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( $r ) => cantata_edit_advanced_code_permission( (int) $r['post_id'] ),

Registered argument schema#

{
  "post_id": {
    "type": "integer",
    "required": true
  },
  "rev": {
    "type": "string",
    "required": true
  },
  "element": {
    "type": "integer",
    "required": true,
    "minimum": 1
  },
  "intent": {
    "type": "string",
    "required": true,
    "enum": [
      "advanced-exception"
    ]
  },
  "css": {
    "type": "string"
  },
  "javascript": {
    "type": "string"
  }
}

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

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/advanced-code-api.php:124, includes/advanced-code-api.php:125, includes/advanced-code-api.php:130, includes/advanced-code-api.php:131. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.