Merge pull request #83 from badasswp/feat/add-custom-filter-to-restrict-post-types

Feat: Add custom filter `excludedPostTypes` to restrict specific Post types

Author: badasswp

.github/workflows/ci.yml

@@ -20,6 +20,9 @@ jobs:
         with:
           node-version: 20.x
 
+      - name: Clear Yarn cache
+        run: yarn cache clean
+
       - name: Install NPM
         run: |
           yarn install

CHANGELOG.md

@@ -4,7 +4,7 @@
 * Feat: Add toggle for Regex expression matching.
 * Feat: Add Plugin options page.
 * Feat: Add Shortcut command (CMD + F).
-* Feat: Add custom hooks: `afterSearchReplace`.
+* Feat: Add custom hooks: `afterSearchReplace`, `excludedPostTypes`.
 * Test: Add e2e tests for plugin codebase.
 * Tested up to WP 6.9.
 

README.md

@@ -77,6 +77,31 @@ addFilter(
 - allowedBlocks _`{string[]}`_ List of Allowed Blocks.
 <br/>
 
+#### `search-replace-for-block-editor.excludedPostTypes`
+
+This custom hook (filter) provides the ability to prevent the loading of the Search & Replace app for specific post types like so:
+
+```js
+import { addFilter } from '@wordpress/hooks';
+
+addFilter(
+	'search-replace-for-block-editor.excludedPostTypes',
+	'yourNamespace',
+	( excludedPostTypes ) => {
+		if ( ! excludedPostTypes.includes( 'page' ) ) {
+			excludedPostTypes.push( 'page' );
+		}
+
+		return excludedPostTypes;
+	}
+);
+```
+
+**Parameters**
+
+- excludedPostTypes _`{string[]}`_ List of Allowed Blocks.
+<br/>
+
 #### `search-replace-for-block-editor.replaceBlockAttribute`
 
 This custom hook (action) provides the ability to include search and replace functionality for custom blocks with custom properties:

inc/Services/Boot.php

@@ -79,6 +79,7 @@ public function register_assets(): void {
 			'srfbe',
 			[
 				'wpVersion'              => $wp_version,
+				'postType'               => get_post_type() ?? null,
 				'isShortcutEnabled'      => $srfbe['use_shortcut'] ?? null,
 				'isCaseMatchingEnabled'  => $srfbe['case_matching'] ?? null,
 				'isRegexMatchingEnabled' => $srfbe['regex_matching'] ?? null,

readme.txt

@@ -67,7 +67,7 @@ Want to add your personal touch? All of our documentation can be found [here](ht
 * Feat: Add toggle for Regex expression matching.
 * Feat: Add Plugin options page.
 * Feat: Add Shortcut command (CMD + F).
-* Feat: Add custom hooks: `afterSearchReplace`.
+* Feat: Add custom hooks: `afterSearchReplace`, `excludedPostTypes`.
 * Test: Add e2e tests for plugin codebase.
 * Tested up to WP 6.9.
 

src/core/utils.tsx

@@ -357,3 +357,43 @@ export const getShortcutEvent = (): KeyboardEvent => {
 		bubbles: true,
 	} );
 };
+
+/**
+ * Is Allowed for Post type.
+ *
+ * This function checkes to see that the plugin
+ * is allowed for a specific post type.
+ *
+ * @since 1.10.0
+ *
+ * @return {boolean} True/false.
+ */
+export const isAllowedForPostType = (): boolean => {
+	const { postType } = srfbe;
+
+	// Bail out, if undefined.
+	if ( ! postType ) {
+		return false;
+	}
+
+	/**
+	 * Filter if a Post has access to
+	 * Search & Replace app.
+	 *
+	 * @since 1.10.0
+	 *
+	 * @param {string[]} excludedPostTypes Excluded Post types.
+	 * @return {string[]}
+	 */
+	const excludedPostTypes = applyFilters(
+		'search-replace-for-block-editor.excludedPostTypes',
+		[]
+	) as string[];
+
+	// Bail out, if excluded.
+	if ( excludedPostTypes.includes( postType ) ) {
+		return false;
+	}
+
+	return true;
+};

src/index.tsx

@@ -11,12 +11,19 @@ import SearchReplaceForBlockEditor from './core/app';
 import {
 	getAppRoot,
 	getEditorRoot,
+	isAllowedForPostType,
 	isWpVersionGreaterThanOrEqualTo,
 } from './core/utils';
 
 ( async () => {
 	try {
+		// Bail out, if not allowed.
+		if ( ! isAllowedForPostType() ) {
+			return;
+		}
+
 		const app = getAppRoot( ( await getEditorRoot() ) as HTMLElement );
+
 		if ( ! isWpVersionGreaterThanOrEqualTo( '6.2.0' ) ) {
 			ReactDOM.render( <SearchReplaceForBlockEditor />, app );
 		} else {

src/typings/global.d.ts

@@ -1,6 +1,7 @@
 declare global {
   var srfbe: {
     wpVersion: string;
+		postType: string;
 		isShortcutEnabled: boolean;
 		isCaseMatchingEnabled: boolean;
 		isRegexMatchingEnabled: boolean;

tests/unit/js/utils.test.tsx

@@ -224,6 +224,15 @@ describe( 'getBlockEditorIframe', () => {
 	} );
 } );
 
+const localizedValues = {
+	postType: 'post',
+	isShortcutEnabled: true,
+	isCaseMatchingEnabled: false,
+	isRegexMatchingEnabled: false,
+	isCloseModalEnabled: false,
+	isSavePostEnabled: false,
+};
+
 describe( 'isWpVersionGreaterThanOrEqualTo', () => {
 	beforeEach( () => {
 		jest.resetModules();
@@ -232,6 +241,7 @@ describe( 'isWpVersionGreaterThanOrEqualTo', () => {
 	it( 'isWpVersionGreaterThanOrEqualTo returns true if WP version is up to or above passed in arg version', () => {
 		window.srfbe = {
 			wpVersion: '6.7.2',
+			...localizedValues,
 		};
 
 		const {
@@ -247,6 +257,7 @@ describe( 'isWpVersionGreaterThanOrEqualTo', () => {
 	it( 'isWpVersionGreaterThanOrEqualTo returns false if WP version is not up to passed in arg version', () => {
 		window.srfbe = {
 			wpVersion: '6.7.0',
+			...localizedValues,
 		};
 
 		const {
@@ -262,6 +273,7 @@ describe( 'isWpVersionGreaterThanOrEqualTo', () => {
 	it( 'isWpVersionGreaterThanOrEqualTo returns false if param version number is not valid', () => {
 		window.srfbe = {
 			wpVersion: '2.3',
+			...localizedValues,
 		};
 
 		const {
@@ -277,6 +289,7 @@ describe( 'isWpVersionGreaterThanOrEqualTo', () => {
 	it( 'isWpVersionGreaterThanOrEqualTo returns true if one of params has version number without dot notation but is equal to or greater than version number', () => {
 		window.srfbe = {
 			wpVersion: '67',
+			...localizedValues,
 		};
 
 		const {
@@ -292,6 +305,7 @@ describe( 'isWpVersionGreaterThanOrEqualTo', () => {
 	it( 'isWpVersionGreaterThanOrEqualTo returns true if one of params has version number with single dot notation but is equal to or greater than version number', () => {
 		window.srfbe = {
 			wpVersion: '6.8',
+			...localizedValues,
 		};
 
 		const {

tests/unit/php/Services/BootTest.php

@@ -111,12 +111,16 @@ public function test_register_assets() {
 			->with( 'search_replace_for_block_editor', [] )
 			->andReturn( null );
 
+		WP_Mock::userFunction( 'get_post_type' )
+			->andReturn( 'post' );
+
 		WP_Mock::userFunction( 'wp_localize_script' )
 			->with(
 				'search-replace-for-block-editor',
 				'srfbe',
 				[
 					'wpVersion'              => '6.9.1',
+					'postType'               => 'post',
 					'isShortcutEnabled'      => null,
 					'isCaseMatchingEnabled'  => null,
 					'isRegexMatchingEnabled' => null,