components REST endpoint
Read theme component choices.
Endpoint#
Read theme component choices.
/wp-json/cantata-edit/v1/components
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( $req ) => $req['post_id'] ? current_user_can( 'edit_post', (int) $req['post_id'] ) : current_user_can( 'edit_pages' ),
Registered argument schema#
{
"post_id": {
"type": "integer",
"minimum": 1
}
}
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#
- cantata_edit_components
- cantata_edit_element_js_owner_for_post
- cantata_edit_template_code_grant_html
- cantata_edit_template_code_state
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.