Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ const MY_TEMPLATE = [
{% end %}

Use the `templateLock` property to lock down the template. Using `all` locks the template complete, no changes can be made. Using `insert` prevents additional blocks to be inserted, but existing blocks can be reordered. See [templateLock documentation](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/inner-blocks/README.md#templatelock) for additional information.
If `templateLock` property is not explicitly passed to the InnerBlocks area and a block contains an attribute name `templateLock` the value of the attribute is used as the `templateLock` property.

### Post Template

Expand Down
5 changes: 3 additions & 2 deletions packages/block-editor/src/components/inner-blocks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,10 @@ Template locking allows locking the `InnerBlocks` area for the current template.
- `'insert'` — prevents inserting or removing blocks, but allows moving existing ones.
- `false` — prevents locking from being applied to an `InnerBlocks` area even if a parent block contains locking. ( Boolean )

If locking is not set in an `InnerBlocks` area: the locking of the parent `InnerBlocks` area is used.
If locking is not set in an `InnerBlocks` area and an attribute named `templateLock` exists the value of the attribute is used as `templateLock`. If locking is not set either as property of the `InnerBlocks` area or as an attribute, the `templateLock` default value of `false`is used.

The `template` property allows setting the attributes of the child blocks and can set `templateLock` of the descent blocks. This allows an ancestor to control the locking of child block areas part of its template.

If the block is a top level block: the locking of the Custom Post Type is used.

### `renderAppender`
* **Type:** `Function|false`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,15 @@ export default function useNestedSettingsUpdate(
) {
const { updateBlockListSettings } = useDispatch( 'core/block-editor' );

const { blockListSettings, parentLock } = useSelect(
const { blockListSettings, templateLockAttribute } = useSelect(
( select ) => {
const rootClientId = select(
const { getBlockListSettings, getBlockAttributes } = select(
'core/block-editor'
).getBlockRootClientId( clientId );
);
return {
blockListSettings: select(
'core/block-editor'
).getBlockListSettings( clientId ),
parentLock: select( 'core/block-editor' ).getTemplateLock(
rootClientId
),
blockListSettings: getBlockListSettings( clientId ),
templateLockAttribute: getBlockAttributes( clientId )
.templateLock,
};
},
[ clientId ]
Expand All @@ -53,7 +50,9 @@ export default function useNestedSettingsUpdate(
const newSettings = {
allowedBlocks,
templateLock:
templateLock === undefined ? parentLock : templateLock,
templateLock === undefined
? templateLockAttribute
: templateLock,
};

// These values are not defined for RN, so only include them if they
Expand All @@ -74,9 +73,9 @@ export default function useNestedSettingsUpdate(
blockListSettings,
allowedBlocks,
templateLock,
parentLock,
captureToolbars,
orientation,
updateBlockListSettings,
templateLockAttribute,
] );
}
5 changes: 5 additions & 0 deletions packages/block-library/src/buttons/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
"apiVersion": 2,
"name": "core/buttons",
"category": "design",
"attributes": {
"templateLock": {
"type": "string"
}
},
"supports": {
"anchor": true,
"align": true,
Expand Down
3 changes: 3 additions & 0 deletions packages/block-library/src/column/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
},
"width": {
"type": "string"
},
"templateLock": {
"type": "string"
}
},
"supports": {
Expand Down
1 change: 0 additions & 1 deletion packages/block-library/src/column/edit.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ function ColumnEdit( {
style: width ? { flexBasis: width } : undefined,
} );
const innerBlocksProps = useInnerBlocksProps( blockProps, {
templateLock: false,
renderAppender: hasChildBlocks
? undefined
: InnerBlocks.ButtonBlockAppender,
Expand Down
3 changes: 3 additions & 0 deletions packages/block-library/src/cover/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@
},
"contentPosition": {
"type": "string"
},
"templateLock": {
"type": "string"
}
},
"supports": {
Expand Down
3 changes: 3 additions & 0 deletions packages/block-library/src/group/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
"tagName": {
"type": "string",
"default": "div"
},
"templateLock": {
"type": "string"
}
},
"supports": {
Expand Down
3 changes: 3 additions & 0 deletions packages/block-library/src/media-text/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@
},
"focalPoint": {
"type": "object"
},
"templateLock": {
"type": "string"
}
},
"supports": {
Expand Down
3 changes: 3 additions & 0 deletions packages/block-library/src/navigation/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
"showSubmenuIcon": {
"type": "boolean",
"default": true
},
"templateLock": {
"type": "string"
}
},
"providesContext": {
Expand Down
4 changes: 0 additions & 4 deletions packages/block-library/src/navigation/edit.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,6 @@ function Navigation( {
templateInsertUpdatesSelection: false,
__experimentalAppenderTagName: 'li',
__experimentalCaptureToolbars: true,
// Template lock set to false here so that the Nav
// Block on the experimental menus screen does not
// inherit templateLock={ 'all' }.
templateLock: false,
}
);

Expand Down
3 changes: 3 additions & 0 deletions packages/block-library/src/social-links/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
"openInNewTab": {
"type": "boolean",
"default": false
},
"templateLock": {
"type": "string"
}
},
"providesContext": {
Expand Down
1 change: 0 additions & 1 deletion packages/block-library/src/social-links/edit.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ export function SocialLinksEdit( props ) {
const blockProps = useBlockProps();
const innerBlocksProps = useInnerBlocksProps( blockProps, {
allowedBlocks: ALLOWED_BLOCKS,
templateLock: false,
template: TEMPLATE,
orientation: 'horizontal',
__experimentalAppenderTagName: 'li',
Expand Down
1 change: 0 additions & 1 deletion packages/block-library/src/social-links/edit.native.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ function SocialLinksEdit( {
return (
<InnerBlocks
allowedBlocks={ ALLOWED_BLOCKS }
templateLock={ false }
template={ initialCreation && TEMPLATE }
renderFooterAppender={
shouldRenderFooterAppender && renderFooterAppender.current
Expand Down
50 changes: 50 additions & 0 deletions packages/e2e-tests/plugins/cpt-locking.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,56 @@ function gutenberg_test_cpt_locking() {
'template_lock' => false,
)
);
register_post_type(
'ul-post-ul-group',
array(
'public' => true,
'label' => 'Locked Post Unlocked group',
'show_in_rest' => true,
'template' => array(
array(
'core/group',
array(),
array(
array( 'core/quote' ),
array(
'core/paragraph',
array(
'placeholder' => 'Add a description',
),
),
),
),
),
'template_lock' => 'all',
)
);
register_post_type(
'l-post-l-group',
array(
'public' => true,
'label' => 'Locked Post Locked group',
'show_in_rest' => true,
'template' => array(
array(
'core/group',
array(
'templateLock' => 'all',
),
array(
array( 'core/quote' ),
array(
'core/paragraph',
array(
'placeholder' => 'Add a description',
),
),
),
),
),
'template_lock' => 'all',
)
);
}

add_action( 'init', 'gutenberg_test_cpt_locking' );
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,26 @@ exports[`cpt locking template_lock all should not error when deleting the cotent
<!-- /wp:columns -->"
`;

exports[`cpt locking template_lock all unlocked group should allow blocks to be moved 1`] = `
"<!-- wp:group -->
<div class=\\"wp-block-group\\"><div class=\\"wp-block-group__inner-container\\"><!-- wp:paragraph {\\"placeholder\\":\\"Add a description\\"} -->
<p>p1</p>
<!-- /wp:paragraph -->

<!-- wp:quote -->
<blockquote class=\\"wp-block-quote\\"><p></p></blockquote>
<!-- /wp:quote --></div></div>
<!-- /wp:group -->"
`;

exports[`cpt locking template_lock all unlocked group should allow blocks to be removed 1`] = `
"<!-- wp:group -->
<div class=\\"wp-block-group\\"><div class=\\"wp-block-group__inner-container\\"><!-- wp:quote -->
<blockquote class=\\"wp-block-quote\\"><p></p></blockquote>
<!-- /wp:quote --></div></div>
<!-- /wp:group -->"
`;

exports[`cpt locking template_lock false should allow blocks to be inserted 1`] = `
"<!-- wp:image -->
<figure class=\\"wp-block-image\\"><img alt=\\"\\"/></figure>
Expand Down
43 changes: 43 additions & 0 deletions packages/e2e-tests/specs/editor/plugins/cpt-locking.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -180,4 +180,47 @@ describe( 'cpt locking', () => {

it( 'should allow blocks to be moved', shouldAllowBlocksToBeMoved );
} );

describe( 'template_lock all unlocked group', () => {
beforeEach( async () => {
await createNewPost( {
postType: 'ul-post-ul-group',
} );
} );

it( 'should allow blocks to be removed', async () => {
await page.type(
'.block-editor-rich-text__editable[data-type="core/paragraph"]',
'p1'
);
await clickBlockToolbarButton( 'More options' );
const [ removeBlock ] = await page.$x(
'//button[contains(text(), "Remove block")]'
);
await removeBlock.click();
expect( await getEditedPostContent() ).toMatchSnapshot();
} );

it( 'should allow blocks to be moved', shouldAllowBlocksToBeMoved );
} );

describe( 'template_lock all locked group', () => {
beforeEach( async () => {
await createNewPost( {
postType: 'l-post-l-group',
} );
} );

it(
'should not allow blocks to be removed',
shouldNotAllowBlocksToBeRemoved
);

it( 'should not allow blocks to be moved', async () => {
await page.click(
'.block-editor-rich-text__editable[data-type="core/paragraph"]'
);
expect( await page.$( 'button[aria-label="Move up"]' ) ).toBeNull();
} );
} );
} );
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ export default function WidgetAreaInnerBlocks() {
value={ blocks }
onInput={ onInput }
onChange={ onChange }
templateLock={ false }
renderAppender={ InnerBlocks.DefaultBlockAppender }
/>
);
Expand Down