Disable pattern overrides block binding source when editing original …

…pattern
WordPress · Jun 25, 2024 · 383b9fa · 383b9fa
1 parent d97e3f7
commit 383b9fa
Show file tree

Hide file tree

Showing 8 changed files with 70 additions and 17 deletions.
diff --git a/packages/block-editor/src/hooks/use-bindings-attributes.js b/packages/block-editor/src/hooks/use-bindings-attributes.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { store as blocksStore } from '@wordpress/blocks';
+import {
+	store as blocksStore,
+	privateApis as blocksPrivateApis,
+} from '@wordpress/blocks';
 import { createHigherOrderComponent } from '@wordpress/compose';
 import { useRegistry, useSelect } from '@wordpress/data';
 import { useCallback, useMemo } from '@wordpress/element';
@@ -12,6 +15,8 @@ import { addFilter } from '@wordpress/hooks';
  */
 import { unlock } from '../lock-unlock';
 
+const { isBindingSourceActiveKey } = unlock( blocksPrivateApis );
+
 /** @typedef {import('@wordpress/compose').WPHigherOrderComponent} WPHigherOrderComponent */
 /** @typedef {import('@wordpress/blocks').WPBlockSettings} WPBlockSettings */
 
@@ -92,14 +97,25 @@ export function canBindAttribute( blockName, attributeName ) {
 
 export const withBlockBindingSupport = createHigherOrderComponent(
 	( BlockEdit ) => ( props ) => {
+		const { name, clientId, context } = props;
 		const registry = useRegistry();
-		const sources = useSelect( ( select ) =>
+		const registeredSources = useSelect( ( select ) =>
 			unlock( select( blocksStore ) ).getAllBlockBindingsSources()
 		);
-		const { name, clientId, context } = props;
+		const sources = Object.fromEntries(
+			Object.entries( registeredSources ).filter(
+				( [ , sourceData ] ) =>
+					sourceData[ isBindingSourceActiveKey ]?.( {
+						registry,
+						clientId,
+					} ) ?? true
+			)
+		);
 		const hasPatternOverridesDefaultBinding =
+			!! sources[ 'core/pattern-overrides' ] &&
 			props.attributes.metadata?.bindings?.[ DEFAULT_ATTRIBUTE ]
 				?.source === 'core/pattern-overrides';
+
 		const bindings = useMemo(
 			() =>
 				replacePatternOverrideDefaultBindings(

diff --git a/packages/blocks/README.md b/packages/blocks/README.md
@@ -462,6 +462,10 @@ _Returns_
 
 -   `Array|string`: A list of blocks or a string, depending on `handlerMode`.
 
+### privateApis
+
+Private @wordpress/blocks APIs.
+
 ### rawHandler
 
 Converts an HTML string to known blocks.

diff --git a/packages/blocks/src/index.js b/packages/blocks/src/index.js
@@ -11,3 +11,4 @@
 export { store } from './store';
 export * from './api';
 export * from './deprecated';
+export { privateApis } from './private-apis';
diff --git a/packages/blocks/src/private-apis.js b/packages/blocks/src/private-apis.js
@@ -0,0 +1,13 @@
+/**
+ * Internal dependencies
+ */
+import { lock } from './lock-unlock';
+import { isBindingSourceActiveKey } from './store/constants';
+
+/**
+ * Private @wordpress/blocks APIs.
+ */
+export const privateApis = {};
+lock( privateApis, {
+	isBindingSourceActiveKey,
+} );
diff --git a/packages/blocks/src/store/constants.js b/packages/blocks/src/store/constants.js
@@ -1 +1,3 @@
 export const STORE_NAME = 'core/blocks';
+
+export const isBindingSourceActiveKey = Symbol( 'isActive' );
diff --git a/packages/blocks/src/store/private-actions.js b/packages/blocks/src/store/private-actions.js
@@ -49,12 +49,6 @@ export function addUnprocessedBlockType( name, blockType ) {
 export function registerBlockBindingsSource( source ) {
 	return {
 		type: 'REGISTER_BLOCK_BINDINGS_SOURCE',
-		sourceName: source.name,
-		sourceLabel: source.label,
-		getValue: source.getValue,
-		setValue: source.setValue,
-		setValues: source.setValues,
-		getPlaceholder: source.getPlaceholder,
-		canUserEditValue: source.canUserEditValue,
+		source,
 	};
 }
diff --git a/packages/blocks/src/store/reducer.js b/packages/blocks/src/store/reducer.js
@@ -13,6 +13,7 @@ import { __ } from '@wordpress/i18n';
  * Internal dependencies
  */
 import { omit } from '../api/utils';
+import { isBindingSourceActiveKey } from './constants';
 
 /**
  * @typedef {Object} WPBlockCategory
@@ -373,15 +374,18 @@ export function collections( state = {}, action ) {
 
 export function blockBindingsSources( state = {}, action ) {
 	if ( action.type === 'REGISTER_BLOCK_BINDINGS_SOURCE' ) {
+		const { source } = action;
 		return {
 			...state,
-			[ action.sourceName ]: {
-				label: action.sourceLabel,
-				getValue: action.getValue,
-				setValue: action.setValue,
-				setValues: action.setValues,
-				getPlaceholder: action.getPlaceholder,
-				canUserEditValue: action.canUserEditValue || ( () => false ),
+			[ source.name ]: {
+				label: source.label,
+				getValue: source.getValue,
+				setValue: source.setValue,
+				setValues: source.setValues,
+				getPlaceholder: source.getPlaceholder,
+				canUserEditValue: source.canUserEditValue || ( () => false ),
+				[ isBindingSourceActiveKey ]:
+					source[ isBindingSourceActiveKey ],
 			},
 		};
 	}

diff --git a/packages/editor/src/bindings/pattern-overrides.js b/packages/editor/src/bindings/pattern-overrides.js
@@ -3,12 +3,31 @@
  */
 import { _x } from '@wordpress/i18n';
 import { store as blockEditorStore } from '@wordpress/block-editor';
+import { privateApis as blocksPrivateApis } from '@wordpress/blocks';
+
+/**
+ * Internal dependencies
+ */
+import { unlock } from '../lock-unlock';
+
+const { isBindingSourceActiveKey } = unlock( blocksPrivateApis );
 
 const CONTENT = 'content';
 
 export default {
 	name: 'core/pattern-overrides',
 	label: _x( 'Pattern Overrides', 'block bindings source' ),
+	[ isBindingSourceActiveKey ]: ( { registry, clientId } ) => {
+		const { getBlockParentsByBlockName } =
+			registry.select( blockEditorStore );
+		const [ patternClientId ] = getBlockParentsByBlockName(
+			clientId,
+			'core/block',
+			true
+		);
+
+		return !! patternClientId;
+	},
 	getValue( { registry, clientId, attributeName } ) {
 		const { getBlockAttributes, getBlockParentsByBlockName } =
 			registry.select( blockEditorStore );