Changeset 49492

Timestamp:

11/04/2020 01:03:22 AM (6 years ago)

Author:

noisysocks

Message:

Editor: Add explicit template and template_lock attributes

Add and document the template and template_lock attributes on WP_Post_Type that
are used by the block editor.

Props metalandcoffee.
See #46261.

File:

• trunk/src/wp-includes/class-wp-post-type.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-post-type.php

@@ -260 +260 @@
          */
         public $delete_with_user = null;
+
+        /**
+         * Array of blocks to use as the default initial state for an editor
+         * session. Each item should be an array containing block name and
+         * optional attributes.
+         *
+         * Default empty array.
+         *
+         * @link https://developer.wordpress.org/block-editor/developers/block-api/block-templates/
+         *
+         * @since 5.6.0
+         * @var array $template
+         */
+        public $template = array();
+
+        /**
+         * Whether the block template should be locked if $template is set.
+         *
+         * If set to 'all', the user is unable to insert new blocks, move existing blocks
+         * and delete blocks.
+         * If set to 'insert', the user is able to move existing blocks but is unable to insert
+         * new blocks and delete blocks.
+         *
+         * Default false.
+         *
+         * @link https://developer.wordpress.org/block-editor/developers/block-api/block-templates/
+         *
+         * @since 5.6.0
+         * @var string|bool $template_lock
+         */
+        public $template_lock = false;
 
         /**
@@ -416 +447 @@
                         'rest_base'             => false,
                         'rest_controller_class' => false,
+                        'template'              => array(),
+                        'template_lock'         => false,
                         '_builtin'              => false,
                         '_edit_link'            => 'post.php?post=%d',