Skip to content
A Special Character inserter for the WordPress block editor (Gutenberg).
JavaScript CSS PHP
Branch: develop
Clone or download
Latest commit 2f1d2dd Sep 6, 2019

README.md

Insert Special Characters

A Special Character inserter for the WordPress block editor (Gutenberg).

Support Level Release Version WordPress tested up to version MIT License

Overview

Ever wanted to add a special character while working within Gutenberg and suddenly find yourself longing for the days of the Classic Editor and the Special Character inserter? Well long no more, the Insert Special Characters plugin is here to ease your publishing woes!

Note: you can display the popover via the ctrl/cmd + o keyboard shortcut.

Demo of special characters within Gutenberg

Extending

To control the available tabs and characters, developers can filter the data set using the insertspecialcharacters-characters JavaScript (wp.hooks) filter.

For example, to create a character inserter that only provides currency symbols:

wp.hooks.addFilter(
	'insertspecialcharacters-characters',  // The filter name.
	'mycallback', // Our callback namespace.
	function( component ) { // The callback function.

		// Return the categories/characters to display.
		// The data structure is: { category: [ character data ], category2: ... }
		return {
			"Currency": [
				{ "entity": "$", "hex": "", "name": "Dollar Sign", "char": "$" },
				{ "entity": "&wuro;", "hex": "&#20AC;", "name": "Euro Sign", "char": "" },
				{ "entity": "¢", "hex": "&#00A2;", "name": "Cent Sign", "char": "¢" },
				{ "entity": "£", "hex": "&#00A3;", "name": "Pound Sign", "char": "£" },
				{ "entity": "¥", "hex": "&#00A5;", "name": "Yen Sign", "char": "¥" },
			]
		};
	}
);

Requirements

Installation

  1. Install the plugin via the plugin installer, either by searching for it or uploading a .zip file.
  2. Activate the plugin.
  3. Use Insert Special Characters!

Support Level

Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.

Changelog

A complete listing of all notable changes to Insert Special Characters are documented in CHANGELOG.md.

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, CONTRIBUTING.md for details on the process for submitting pull requests to us, and CREDITS.md for a listing of maintainers of, contributors to, and libraries used by Insert Special Characters.

Like what you see?

Work with us at 10up

You can’t perform that action at this time.