Kindly EditDocumentationTry the editor

element-php/read REST endpoint

Validate, stage, or read authorized PHP resources and inspect provider information.

Endpoint#

Validate, stage, or read authorized PHP resources and inspect provider information.

/wp-json/cantata-edit/v1/element-php/read

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:

$author_owner = static function ( WP_REST_Request $req ) {
		$owner = cantata_edit_element_php_rest_owner( $req );
		return ! is_wp_error( $owner ) && cantata_edit_can_author_php() && cantata_edit_element_php_can_edit_owner( $owner );
	};

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.

Callback input keys#

owner, refs. 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/element-php.php:920, includes/element-php.php:937. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.