Kindly EditDocumentationTry the editor

screens REST endpoint

Read or update enabled site screen sizes and their boundaries.

Endpoint#

Read or update enabled site screen sizes and their boundaries.

/wp-json/cantata-edit/v1/screens

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() => current_user_can( 'edit_pages' ),

Registered argument schema#

[]

An empty schema means the route did not declare arguments in its registration. It does not mean that the callback accepts arbitrary data or has no required body fields. Callback-level validation remains authoritative.

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() => current_user_can( 'manage_options' ) && cantata_edit_can_dev(),

Registered argument schema#

[]

An empty schema means the route did not declare arguments in its registration. It does not mean that the callback accepts arbitrary data or has no required body fields. Callback-level validation remains authoritative.

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/responsive.php:271, includes/responsive.php:272, includes/responsive.php:276, includes/responsive.php:277. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.