Adds content locking to navigation block.

Adds a new block api method `isNavigationBlock` to complement `isReusableBlock`.
WordPress · Oct 6, 2022 · f4f02ae · f4f02ae
1 parent b662575
commit f4f02ae
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 18 deletions.
diff --git a/packages/block-editor/src/components/block-lock/modal.js b/packages/block-editor/src/components/block-lock/modal.js
@@ -15,7 +15,11 @@ import {
 import { lock as lockIcon, unlock as unlockIcon } from '@wordpress/icons';
 import { useInstanceId } from '@wordpress/compose';
 import { useDispatch, useSelect } from '@wordpress/data';
-import { isReusableBlock, getBlockType } from '@wordpress/blocks';
+import {
+	isReusableBlock,
+	isNavigationBlock,
+	getBlockType,
+} from '@wordpress/blocks';
 
 /**
  * Internal dependencies
@@ -41,21 +45,23 @@ function getTemplateLockValue( lock ) {
 export default function BlockLockModal( { clientId, onClose } ) {
 	const [ lock, setLock ] = useState( { move: false, remove: false } );
 	const { canEdit, canMove, canRemove } = useBlockLock( clientId );
-	const { isReusable, templateLock, hasTemplateLock } = useSelect(
-		( select ) => {
-			const { getBlockName, getBlockAttributes } =
-				select( blockEditorStore );
-			const blockName = getBlockName( clientId );
-			const blockType = getBlockType( blockName );
+	const { isReusable, isNavigation, templateLock, hasTemplateLock } =
+		useSelect(
+			( select ) => {
+				const { getBlockName, getBlockAttributes } =
+					select( blockEditorStore );
+				const blockName = getBlockName( clientId );
+				const blockType = getBlockType( blockName );
 
-			return {
-				isReusable: isReusableBlock( blockType ),
-				templateLock: getBlockAttributes( clientId )?.templateLock,
-				hasTemplateLock: !! blockType?.attributes?.templateLock,
-			};
-		},
-		[ clientId ]
-	);
+				return {
+					isReusable: isReusableBlock( blockType ),
+					isNavigation: isNavigationBlock( blockType ),
+					templateLock: getBlockAttributes( clientId )?.templateLock,
+					hasTemplateLock: !! blockType?.attributes?.templateLock,
+				};
+			},
+			[ clientId ]
+		);
 	const [ applyTemplateLock, setApplyTemplateLock ] = useState(
 		!! templateLock
 	);
@@ -70,9 +76,9 @@ export default function BlockLockModal( { clientId, onClose } ) {
 		setLock( {
 			move: ! canMove,
 			remove: ! canRemove,
-			...( isReusable ? { edit: ! canEdit } : {} ),
+			...( isReusable || isNavigation ? { edit: ! canEdit } : {} ),
 		} );
-	}, [ canEdit, canMove, canRemove, isReusable ] );
+	}, [ canEdit, canMove, canRemove, isReusable, isNavigation ] );
 
 	const isAllChecked = Object.values( lock ).every( Boolean );
 	const isMixed = Object.values( lock ).some( Boolean ) && ! isAllChecked;
@@ -126,7 +132,7 @@ export default function BlockLockModal( { clientId, onClose } ) {
 						}
 					/>
 					<ul className="block-editor-block-lock-modal__checklist">
-						{ isReusable && (
+						{ ( isReusable || isNavigation ) && (
 							<li className="block-editor-block-lock-modal__checklist-item">
 								<CheckboxControl
 									label={

diff --git a/packages/blocks/README.md b/packages/blocks/README.md
@@ -501,6 +501,19 @@ _Returns_
 
 -   `boolean`: True if a block contains at least one child blocks with inserter support and false otherwise.
 
+### isNavigationBlock
+
+Determines whether or not the given block is a navigation block. This is a
+special block type that can used to point to a wp_navigation post type.
+
+_Parameters_
+
+-   _blockOrType_ `Object`: Block or Block Type to test.
+
+_Returns_
+
+-   `boolean`: Whether the given block is a navigation block.
+
 ### isReusableBlock
 
 Determines whether or not the given block is a reusable block. This is a

diff --git a/packages/blocks/src/api/index.js b/packages/blocks/src/api/index.js
@@ -126,6 +126,7 @@ export {
 	hasBlockSupport,
 	getBlockVariations,
 	isReusableBlock,
+	isNavigationBlock,
 	isTemplatePart,
 	getChildBlockNames,
 	hasChildBlocks,

diff --git a/packages/blocks/src/api/registration.js b/packages/blocks/src/api/registration.js
@@ -608,6 +608,18 @@ export function isReusableBlock( blockOrType ) {
 	return blockOrType?.name === 'core/block';
 }
 
+/**
+ * Determines whether or not the given block is a navigation block. This is a
+ * special block type that can used to point to a wp_navigation post type.
+ *
+ * @param {Object} blockOrType Block or Block Type to test.
+ *
+ * @return {boolean} Whether the given block is a navigation block.
+ */
+export function isNavigationBlock( blockOrType ) {
+	return blockOrType?.name === 'core/navigation';
+}
+
 /**
  * Determines whether or not the given block is a template part. This is a
  * special block type that allows composing a page template out of reusable