Framework: Bootstrap Block Templates by youknowriad · Pull Request #3668 · WordPress/gutenberg

youknowriad · 2017-11-27T11:45:28Z

This PR is the first one introducing the Block Templates. (details on those here #3588 )
This first iteration allows:

Defining a template for a CPT
Initialize the editor with a predefined list of blocks if a template is found.

A template object looks like this:

const template = [
  [ 'block/name', {} ], // [ blockName, attributes ]
];

Testing instructions

Add A CPT like this:

function register_book_type() {
	$args = array(
		'public' => true,
		'label'  => 'Books',
		'show_in_rest' => true,
		'template' => array(
			array( 'core/image' ),
			array( 'core/paragraph', array(
				'placeholder' => 'Add a book description',
			) ),
			array( 'core/quote' ),
		),
	);
	register_post_type( 'book', $args );
}
add_action( 'init', 'register_book_type' );

Create a new post with the registered CPT
The editor should initialize with the predefined list of blocks defined in this template.

Notes

Block Attributes need to be initialized properly server-side, we should move away from our Editable Value as React Elements to be able to do so for these attributes (related Editable: state as a cleaned up tree #3048)

codecov · 2017-11-27T11:55:21Z

Codecov Report

Merging #3668 into master will decrease coverage by 0.01%.
The diff coverage is 20%.

@@            Coverage Diff            @@
##           master   #3668      +/-   ##
=========================================
- Coverage   37.32%   37.3%   -0.02%     
=========================================
  Files         277     277              
  Lines        6685    6690       +5     
  Branches     1213    1214       +1     
=========================================
+ Hits         2495    2496       +1     
- Misses       3532    3536       +4     
  Partials      658     658

Impacted Files	Coverage Δ
editor/actions.js	`47.16% <ø> (ø)`	⬆️
editor/components/provider/index.js	`13.33% <0%> (+0.83%)`	⬆️
editor/effects.js	`58.06% <28.57%> (-2.11%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9864a60...8b125bb. Read the comment docs.

mtias · 2017-11-27T12:50:52Z

editor/effects.js

Are we sure we are going to want additional properties on the template object instead of making template = template.blocks?

I don't know honestly. Server-side I think so, because templates could have a name/description but client-side I don't really know. I thought we should do this to avoid future breaking changes.

Yes, just thinking out-loud. There are things like "locking" which might be interesting there. Not sure about naming templates, but maybe an id / slug if they are stored somewhere?

Thinking further, I can't see why we would pair defining blocks and naming in the CPT. If anything, the "template" would be defined outside the CPT and referenced here by slug.

Also, things like locking could be defined as another attribute of the CPT registration, which seems more in line with how we generally structure options:

'template' => array( array( 'core/image' ), array( 'core/paragraph', array( 'placeholder' => 'Add a book description', ) ), array( 'core/quote' ), ), 'template_lock' => true,

Finally, what do you think of simplifying the syntax to not require name => 'core/heading'? I think we can rely on the definition of a block to be array( blockName, attributes ... ).

Sure, I was not sure about the extra keys anyway.

mtias · 2017-11-27T12:51:52Z

editor/effects.js

I love that this fairly low profile implementation wise.

mtias · 2017-11-27T14:08:05Z

This is looking good to me. We probably want to add a test and some documentation. I think we might need a new "Templates" document. (Doesn't have to block this.)

youknowriad · 2017-11-27T14:59:42Z

Merged, let's add the docs and tests separately.

aduth · 2017-11-27T15:12:36Z

lib/client-assets.php

 	);

+	$post_type_object = get_post_type_object( $post_to_edit['type'] );
+	if ( $post_type_object->template ) {


Notice: Undefined property: WP_Post_Type::$template in /srv/www/editor/htdocs/wp-content/plugins/gutenberg/lib/client-assets.php on line 786

I suggest running with high error reporting:

error_reporting( E_ALL );

(Add near top of site root index.php)

You want empty here:

if ( ! empty( $post_type_object->template ) ) {

baerkins · 2017-12-01T16:06:52Z

I'm not sure if this is intended, but omitting 'show_in_rest' => true, or setting it to false results in the default editor appearing.

youknowriad · 2017-12-01T16:26:57Z

@iamhexcoder Yes, this is expected. Gutenberg uses the REST API and if the show_in_rest is false, Gutenberg is not able to fetch an save the CPT. This is a current limitation of the REST API.

We'll figure out a way to solve this. Tracked in #3066

youknowriad added the Framework Issues related to broader framework topics, especially as it relates to javascript label Nov 27, 2017

youknowriad self-assigned this Nov 27, 2017

youknowriad requested review from BE-Webdesign, aduth, ellatrix, gziolo, mcsf and mtias November 27, 2017 11:45

youknowriad force-pushed the add/initialize-editor-with-template branch from 7a8ded7 to 64ab4db Compare November 27, 2017 11:49

mtias reviewed Nov 27, 2017

View reviewed changes

editor/effects.js Outdated

Copy link
Copy Markdown

Member

mtias Nov 27, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love that this fairly low profile implementation wise.

Framework: Bootstrap Block Templates

55454fe

youknowriad force-pushed the add/initialize-editor-with-template branch from 64ab4db to 55454fe Compare November 27, 2017 13:04

Framework: Simplify the block template format

8b125bb

youknowriad merged commit deb51e1 into master Nov 27, 2017

youknowriad deleted the add/initialize-editor-with-template branch November 27, 2017 14:59

aduth reviewed Nov 27, 2017

View reviewed changes

aduth mentioned this pull request Nov 27, 2017

Framework: Check post type template as non-empty #3674

Merged

georgestephanis mentioned this pull request Dec 3, 2017

Blocks: Support block nesting (Add Columns block, InnerBlocks component) #3745

Merged

BinaryMoon mentioned this pull request Jan 6, 2018

Docs - Block Templates #4340

Closed

Conversation

youknowriad commented Nov 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Nov 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mtias Nov 27, 2017

Choose a reason for hiding this comment

Uh oh!

youknowriad Nov 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtias Nov 27, 2017

Choose a reason for hiding this comment

Uh oh!

mtias Nov 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

youknowriad Nov 27, 2017

Choose a reason for hiding this comment

Uh oh!

mtias Nov 27, 2017

Choose a reason for hiding this comment

Uh oh!

mtias commented Nov 27, 2017

Uh oh!

youknowriad commented Nov 27, 2017

Uh oh!

aduth Nov 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aduth Nov 27, 2017

Choose a reason for hiding this comment

Uh oh!

baerkins commented Dec 1, 2017

Uh oh!

youknowriad commented Dec 1, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

youknowriad commented Nov 27, 2017 •

edited

Loading

codecov bot commented Nov 27, 2017 •

edited

Loading

youknowriad Nov 27, 2017 •

edited

Loading

mtias Nov 27, 2017 •

edited

Loading

aduth Nov 27, 2017 •

edited

Loading