<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58452] trunk: REST API: Add template and template_lock to post types endpoint.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58452">58452</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58452","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorgefilipecosta</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-21 13:04:47 +0000 (Fri, 21 Jun 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Add template and template_lock to post types endpoint.
Adds template and template_lock property of the post type to post types REST API endpoint.
This change allows us to fix a bug where the template of a page is not respected when creating a new page on the site editor.
Props jorgefilipecosta, oandregal, timothyblynjacobs, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/61477">#61477</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestposttypescontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestposttypescontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-post-types-controller.php</a></li>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestposttypescontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php 2024-06-21 10:25:49 UTC (rev 58451)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php 2024-06-21 13:04:47 UTC (rev 58452)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -246,6 +246,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data['rest_namespace'] = $namespace;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( rest_is_field_included( 'template', $fields ) ) {
+ $data['template'] = $post_type->template ?? array();
+ }
+
+ if ( rest_is_field_included( 'template_lock', $fields ) ) {
+ $data['template_lock'] = ! empty( $post_type->template_lock ) ? $post_type->template_lock : false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $this->add_additional_fields_to_object( $data, $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $this->filter_response_by_context( $data, $context );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -407,6 +415,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit', 'embed' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'readonly' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'template' => array(
+ 'type' => array( 'array' ),
+ 'description' => __( 'The block template associated with the post type.' ),
+ 'readonly' => true,
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ 'template_lock' => array(
+ 'type' => array( 'string', 'boolean' ),
+ 'enum' => array( 'all', 'insert', 'contentOnly', false ),
+ 'description' => __( 'The template_lock associated with the post type, or false if none.' ),
+ 'readonly' => true,
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestposttypescontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-post-types-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-post-types-controller.php 2024-06-21 10:25:49 UTC (rev 58451)
+++ trunk/tests/phpunit/tests/rest-api/rest-post-types-controller.php 2024-06-21 13:04:47 UTC (rev 58452)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -77,6 +77,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->check_post_type_object_response( 'view', $response, 'cpt' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 61477
+ */
+ public function test_get_item_template_cpt() {
+ register_post_type(
+ 'cpt_template',
+ array(
+ 'show_in_rest' => true,
+ 'rest_base' => 'cpt_template',
+ 'rest_namespace' => 'wordpress/v1',
+ 'template' => array(
+ array( 'core/paragraph', array( 'placeholder' => 'Content' ) ),
+ ),
+ 'template_lock' => 'all',
+ )
+ );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/types/cpt_template' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->check_post_type_object_response( 'view', $response, 'cpt_template' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_item_page() {
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/types/page' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,7 +186,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $properties = $data['schema']['properties'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertCount( 14, $properties, 'Schema should have 14 properties' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertCount( 16, $properties, 'Schema should have 16 properties' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'capabilities', $properties, '`capabilities` should be included in the schema' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'description', $properties, '`description` should be included in the schema' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'hierarchical', $properties, '`hierarchical` should be included in the schema' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -180,6 +201,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'rest_namespace', $properties, '`rest_namespace` should be included in the schema' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'visibility', $properties, '`visibility` should be included in the schema' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'icon', $properties, '`icon` should be included in the schema' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'template', $properties, '`template` should be included in the schema' );
+ $this->assertArrayHasKey( 'template_lock', $properties, '`template_lock` should be included in the schema' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_additional_field_registration() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -230,6 +253,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $post_type_obj->rest_base, $data['rest_base'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $post_type_obj->rest_namespace, $data['rest_namespace'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $post_type_obj->has_archive, $data['has_archive'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( $post_type_obj->template ?? array(), $data['template'] );
+ $this->assertSame( ! empty( $post_type_obj->template_lock ) ? $post_type_obj->template_lock : false, $data['template_lock'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $links = test_rest_expand_compact_links( $links );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( rest_url( 'wp/v2/types' ), $links['collection'][0]['href'] );
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2024-06-21 10:25:49 UTC (rev 58451)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2024-06-21 13:04:47 UTC (rev 58452)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13014,6 +13014,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "posts",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13044,6 +13046,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "taxonomies": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "pages",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13074,6 +13078,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "taxonomies": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "media",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13106,6 +13112,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "menu-items",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13138,6 +13146,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "blocks",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13168,6 +13178,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "taxonomies": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "templates",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13198,6 +13210,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "taxonomies": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "template-parts",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13228,6 +13242,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "taxonomies": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "global-styles",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13258,6 +13274,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "taxonomies": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "navigation",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13288,6 +13306,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "taxonomies": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "font-families",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13318,6 +13338,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "taxonomies": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "font-families/(?P<font_family_id>[\\d]+)/font-faces",
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_namespace": "wp/v2",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "template": [],
+ "template_lock": false,
</ins><span class="cx" style="display: block; padding: 0 10px"> "_links": {
</span><span class="cx" style="display: block; padding: 0 10px"> "collection": [
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13352,7 +13374,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "post_tag"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "rest_base": "posts",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "rest_namespace": "wp/v2"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "rest_namespace": "wp/v2",
+ "template": [],
+ "template_lock": false
</ins><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> mockedApiResponse.StatusesCollection = {
</span></span></pre>
</div>
</div>
</body>
</html>