search-and-replace

Search and Replace text within the Block Editor quickly and easily.

Download

Download from WordPress plugin repository.

You can also get the latest version from any of our release tags.

Why Search and Replace for Block Editor?

This plugin brings the familiar Search and Replace functionality that PC users have grown accustomed to while using Microsoft Word and Google Docs to the Block Editor.

Now you can easily search and replace text right in the Block Editor. Its easy and does exactly what it says. You can also match the text case using the 'Match Case | Expression' toggle.

search-and-replace-text-for-block-editor.mov

Hooks

search-replace-for-block-editor.allowedBlocks

This custom hook (filter) provides the ability to include the search and replace functionality for your custom block:

import { addFilter } from '@wordpress/hooks';

addFilter(
	'search-replace-for-block-editor.allowedBlocks',
	'yourBlocks',
	( allowedBlocks ) => {
		if ( allowedBlocks.indexOf( 'your/block' ) === -1 ) {
			allowedBlocks.push( 'your/block' );
		}

		return allowedBlocks;
	}
);

Parameters

• allowedBlocks {string[]} List of Allowed Blocks.

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:

import { addAction } from '@wordpress/hooks';

addAction(
	'search-replace-for-block-editor.replaceBlockAttribute',
	'yourBlock',
	( replaceBlockAttribute, name, args ) => {
		const prop = 'title';

		switch ( name ) {
			case 'namespace/your-block':
				replaceBlockAttribute( args, prop );
				break;
		}
	}
);

Parameters

• replaceBlockAttribute {Function} By default, this is a function that takes in an args and property as params.
• name {string} By default, this is a string containing the name of the block.
• args {Object} By default, this is an object containing the element, pattern, text and status.

search-replace-for-block-editor.keyboardShortcut

This custom hook (filter) provides a way for users to specify their preferred keyboard shortcut option. For e.g to use the 'K' option on your keyboard, you could do like so:

import { addFilter } from '@wordpress/hooks';

addFilter(
	'search-replace-for-block-editor.keyboardShortcut',
	'yourShortcut',
	( shortcut ) => {
		return {
			character: 'k',
			...shortcut,
		};
	}
);

Parameters

• shortcut {Object} By default this is an object, containing modifier and character properties which together represent the following command CMD + SHIFT + F.

search-replace-for-block-editor.caseSensitive

This custom hook (filter) provides a way for users to specify the case sensitivity of each Search & Replace activity. For e.g. to make it case sensitive, you can do like so:

import { addFilter } from '@wordpress/hooks';

addFilter(
	'search-replace-for-block-editor.caseSensitive',
	'yourCaseSensitivity',
	( isCaseSensitive ) => {
		return true;
	}
);

Parameters

• isCaseSensitive {bool} By default, this is a falsy value.

---

Contribute

Contributions are welcome and will be fully credited. To contribute, please fork this repo and raise a PR (Pull Request) against the master branch.

Pre-requisites

You should have the following tools before proceeding to the next steps:

• Composer
• Yarn
• Docker

To enable you start development, please run:

yarn start

This should spin up a local WP env instance for you to work with at:

http://srbe.localhost:5187

You should now have a functioning local WP env to work with. To login to the wp-admin backend, please use admin for username & password for password.

Awesome! - Thanks for being interested in contributing your time and code to this project!