fix: restructure substitition whitelist to individual blocks

Arukuen · Arukuen · commit 59c436d37ce1 · 2025-01-24T00:38:00.000+08:00
diff --git a/src/block/accordion/block.json b/src/block/accordion/block.json
@@ -16,5 +16,8 @@
 		"stackable/icon-label",
 		"stackable/heading",
 		"stackable/icon"
+	],
+	"stk-substitution-blocks": [
+		"stackable/text"
 	]
 }
diff --git a/src/block/blockquote/block.json b/src/block/blockquote/block.json
@@ -10,5 +10,8 @@
 	"stk-demo": "https://wpstackable.com/blockquote-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",
 	"stk-block-dependencies": [
 		"stackable/icon"
+	],
+	"stk-substitution-blocks": [
+		"stackable/text"
 	]
 }
diff --git a/src/block/call-to-action/block.json b/src/block/call-to-action/block.json
@@ -13,5 +13,11 @@
 	],
 	"textdomain": "stackable-ultimate-gutenberg-blocks",
 	"stk-type": "section",
-	"stk-demo": "https://wpstackable.com/call-to-action-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink"
+	"stk-demo": "https://wpstackable.com/call-to-action-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",
+	"stk-substitution-blocks": [
+		"stackable/heading",
+		"stackable/text",
+		"stackable/button-group",
+		"stackable/button"
+	]
 }
diff --git a/src/block/card/block.json b/src/block/card/block.json
@@ -10,5 +10,12 @@
 	},
 	"textdomain": "stackable-ultimate-gutenberg-blocks",
 	"stk-type": "special",
-	"stk-demo": "https://wpstackable.com/card-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink"
+	"stk-demo": "https://wpstackable.com/card-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",
+	"stk-substitution-blocks": [
+		"stackable/heading",
+		"stackable/text",
+		"stackable/subtitle",
+		"stackable/button-group",
+		"stackable/button"
+	]
 }
diff --git a/src/block/feature-grid/block.json b/src/block/feature-grid/block.json
@@ -10,5 +10,12 @@
 	},
 	"textdomain": "stackable-ultimate-gutenberg-blocks",
 	"stk-type": "section",
-	"stk-demo": "https://wpstackable.com/feature-grid-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink"
+	"stk-demo": "https://wpstackable.com/feature-grid-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",
+	"stk-substitution-blocks": [
+		"stackable/image",
+		"stackable/heading",
+		"stackable/text",
+		"stackable/button-group",
+		"stackable/button"
+	]
 }
diff --git a/src/block/feature/block.json b/src/block/feature/block.json
@@ -13,5 +13,11 @@
 	"stk-demo": "https://wpstackable.com/feature-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",
 	"stk-block-dependencies": [
 		"stackable/image"
+	],
+	"stk-substitution-blocks": [
+		"stackable/heading",
+		"stackable/text",
+		"stackable/button-group",
+		"stackable/button"
 	]
 }
diff --git a/src/block/hero/block.json b/src/block/hero/block.json
@@ -18,5 +18,11 @@
 	],
 	"textdomain": "stackable-ultimate-gutenberg-blocks",
 	"stk-type": "section",
-	"stk-demo": "https://wpstackable.com/hero-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink"
+	"stk-demo": "https://wpstackable.com/hero-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",
+	"stk-substitution-blocks": [
+		"stackable/heading",
+		"stackable/text",
+		"stackable/button-group",
+		"stackable/button"
+	]
 }
diff --git a/src/block/image-box/block.json b/src/block/image-box/block.json
@@ -12,5 +12,9 @@
 		"stackable/image",
 		"stackable/subtitle",
 		"stackable/icon"
+	],
+	"stk-substitution-blocks": [
+		"stackable/heading",
+		"stackable/text"
 	]
 }
diff --git a/src/block/notification/block.json b/src/block/notification/block.json
@@ -14,5 +14,11 @@
 	],
 	"textdomain": "stackable-ultimate-gutenberg-blocks",
 	"stk-type": "special",
-	"stk-demo": "https://wpstackable.com/notification-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink"
+	"stk-demo": "https://wpstackable.com/notification-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",
+	"stk-substitution-blocks": [
+		"stackable/heading",
+		"stackable/text",
+		"stackable/button-group",
+		"stackable/button"
+	]
 }
diff --git a/src/block/pricing-box/block.json b/src/block/pricing-box/block.json
@@ -20,5 +20,11 @@
 		"stackable/price",
 		"stackable/text",
 		"stackable/icon-list"
+	],
+	"stk-substitution-blocks": [
+		"stackable/heading",
+		"stackable/subtitle",
+		"stackable/button-group",
+		"stackable/button"
 	]
 }
diff --git a/src/block/team-member/block.json b/src/block/team-member/block.json
@@ -10,5 +10,13 @@
 	},
 	"textdomain": "stackable-ultimate-gutenberg-blocks",
 	"stk-type": "section",
-	"stk-demo": "https://wpstackable.com/team-member-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink"
+	"stk-demo": "https://wpstackable.com/team-member-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",
+	"stk-substitution-blocks": [
+		"stackable/image",
+		"stackable/heading",
+		"stackable/subtitle",
+		"stackable/text",
+		"stackable/button-group",
+		"stackable/button"
+	]
 }
diff --git a/src/disabled-blocks.js b/src/disabled-blocks.js
@@ -11,22 +11,6 @@ import {
 } from '~stackable/util'
 import _ from 'lodash'
 
-// Contains the hookname of block variations and a list of whitelisted block names to substitute.
-const VARIATION_FILTERS_WHITELIST = {
-	'stackable.accordion.variations': [ 'stackable/text' ],
-	'stackable.card.variations': [ 'stackable/heading', 'stackable/text', 'stackable/subtitle', 'stackable/button-group', 'stackable/button' ],
-	'stackable.image-box.variations': [ 'stackable/heading', 'stackable/text' ],
-	'stackable.notification.variations': [ 'stackable/heading', 'stackable/text', 'stackable/button-group', 'stackable/button' ],
-	'stackable.blockquote.variations': [ 'stackable/text' ],
-	'stackable.call-to-action.variations': [ 'stackable/heading', 'stackable/text', 'stackable/button-group', 'stackable/button' ],
-	'stackable.feature.variations': [ 'stackable/heading', 'stackable/text', 'stackable/button-group', 'stackable/button' ],
-	'stackable.feature-grid.variations': [ 'stackable/image', 'stackable/heading', 'stackable/text', 'stackable/button-group', 'stackable/button' ],
-	'stackable.hero.variations': [ 'stackable/heading', 'stackable/text', 'stackable/button-group', 'stackable/button' ],
-	'stackable.pricing-box.variations': [ 'stackable/heading', 'stackable/subtitle', 'stackable/button-group', 'stackable/button' ],
-	'stackable.team-member.variations': [ 'stackable/image', 'stackable/heading', 'stackable/subtitle', 'stackable/text', 'stackable/button-group', 'stackable/button' ],
-	'stackable.testimonial.variations': [ 'stackable/image', 'stackable/heading', 'stackable/subtitle', 'stackable/text' ],
-}
-
 const getDefaultVariation = variations => {
 	return variations?.find( ( { isDefault } ) => isDefault )?.name
 }
@@ -40,6 +24,27 @@ const getVariationsToRemove = ( disabledBlocks, blockName ) => {
 	return variations
 }
 
+// Traverse the innerblocks of a given block definition and substitute core blocks if disabled and whitelisted.
+const traverseBlocksAndSubstitute = ( blocks, whitelist ) => {
+	return blocks.map( block => {
+		let [ blockName, blockAttributes, innerBlocks ] = block
+
+		// If there are innerBlocks, recursively traverse them.
+		if ( innerBlocks && innerBlocks.length > 0 ) {
+			innerBlocks = traverseBlocksAndSubstitute( innerBlocks, whitelist )
+		}
+
+		if ( whitelist.includes( blockName ) ) {
+			return substituteCoreIfDisabled( blockName, blockAttributes, innerBlocks )
+		}
+
+		if ( innerBlocks ) {
+			return [ blockName, blockAttributes, innerBlocks ]
+		}
+		return [ blockName, blockAttributes ]
+	} )
+}
+
 const applySettingsToMeta = metadata => {
 	const disabledBlocks = settings.stackable_block_states || {} // eslint-disable-line camelcase
 	let inserter = true
@@ -76,6 +81,17 @@ const applySettingsToMeta = metadata => {
 		}
 	}
 
+	const whitelist = metadata[ 'stk-substitution-blocks' ]
+	if ( whitelist ) {
+		variations = variations.map( variation => {
+			const newVariation = _.cloneDeep( variation )
+			if ( newVariation.innerBlocks && Array.isArray( newVariation.innerBlocks ) ) {
+				newVariation.innerBlocks = traverseBlocksAndSubstitute( newVariation.innerBlocks, whitelist )
+			}
+			return newVariation
+		} )
+	}
+
 	// Adjust the metadata.
 	metadata.variations = variations
 	if ( typeof metadata.supports === 'undefined' ) {
@@ -87,38 +103,3 @@ const applySettingsToMeta = metadata => {
 }
 
 addFilter( 'stackable.block.metadata', 'stackable/disabled-blocks', applySettingsToMeta )
-
-// Traverse the innerblocks of a given block definition and substitute core blocks if disabled and whitelisted.
-const traverseBlocksAndSubstitute = ( blocks, whitelist ) => {
-	return blocks.map( block => {
-		let [ blockName, blockAttributes, innerBlocks ] = block
-
-		// If there are innerBlocks, recursively traverse them.
-		if ( innerBlocks && innerBlocks.length > 0 ) {
-			innerBlocks = traverseBlocksAndSubstitute( innerBlocks, whitelist )
-		}
-
-		if ( whitelist.includes( blockName ) ) {
-			return substituteCoreIfDisabled( blockName, blockAttributes, innerBlocks )
-		}
-
-		if ( innerBlocks ) {
-			return [ blockName, blockAttributes, innerBlocks ]
-		}
-		return [ blockName, blockAttributes ]
-	} )
-}
-
-Object.entries( VARIATION_FILTERS_WHITELIST ).forEach( ( [ hookName, whitelist ] ) => {
-	// Make sure to run after pro filters
-	addFilter( hookName, 'stackable/disabled-blocks', blockVariations => {
-		return blockVariations.map( variation => {
-			const newVariation = _.cloneDeep( variation )
-			if ( newVariation.innerBlocks && Array.isArray( newVariation.innerBlocks ) ) {
-				newVariation.innerBlocks = traverseBlocksAndSubstitute( newVariation.innerBlocks, whitelist )
-			}
-			return newVariation
-		} )
-	}, 11 )
-} )
-

Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,8 @@`
`16`	`16`	`"stackable/icon-label",`
`17`	`17`	`"stackable/heading",`
`18`	`18`	`"stackable/icon"`
	`19`	`+ ],`
	`20`	`+ "stk-substitution-blocks": [`
	`21`	`+ "stackable/text"`
`19`	`22`	`]`
`20`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,8 @@`
`10`	`10`	`"stk-demo": "https://wpstackable.com/blockquote-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",`
`11`	`11`	`"stk-block-dependencies": [`
`12`	`12`	`"stackable/icon"`
	`13`	`+ ],`
	`14`	`+ "stk-substitution-blocks": [`
	`15`	`+ "stackable/text"`
`13`	`16`	`]`
`14`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,11 @@`
`13`	`13`	`"stk-demo": "https://wpstackable.com/feature-block/?utm_source=welcome&utm_medium=settings&utm_campaign=view_demo&utm_content=demolink",`
`14`	`14`	`"stk-block-dependencies": [`
`15`	`15`	`"stackable/image"`
	`16`	`+ ],`
	`17`	`+ "stk-substitution-blocks": [`
	`18`	`+ "stackable/heading",`
	`19`	`+ "stackable/text",`
	`20`	`+ "stackable/button-group",`
	`21`	`+ "stackable/button"`
`16`	`22`	`]`
`17`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,9 @@`
`12`	`12`	`"stackable/image",`
`13`	`13`	`"stackable/subtitle",`
`14`	`14`	`"stackable/icon"`
	`15`	`+ ],`
	`16`	`+ "stk-substitution-blocks": [`
	`17`	`+ "stackable/heading",`
	`18`	`+ "stackable/text"`
`15`	`19`	`]`
`16`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,11 @@`
`20`	`20`	`"stackable/price",`
`21`	`21`	`"stackable/text",`
`22`	`22`	`"stackable/icon-list"`
	`23`	`+ ],`
	`24`	`+ "stk-substitution-blocks": [`
	`25`	`+ "stackable/heading",`
	`26`	`+ "stackable/subtitle",`
	`27`	`+ "stackable/button-group",`
	`28`	`+ "stackable/button"`
`23`	`29`	`]`
`24`	`30`	`}`