I'm writing a function to allow only some custom blocks - essentially I want to register all the blocks, then based on a database table of 'selected' blocks disallow any other custom block.
I can use allowed_block_types to make an array of allowed blocks, but it wipes all the core ones, is there a way to either get a reliable list of core blocks, or only add a filter for plugin/theme registered blocks? Or possibly, allow all block
categories then my own block category is filtered?
AFAIK there is only one way to remove blocks from Gutenberg - you have to use allowed_block_types filter.
Unfortunately Gutenberg developers are not very familiar with WordPress hooks and filters, so they created a little monster with this one. So instead of passing a list of core blocks in there, they pass true to enable all blocks. That way you're unable to obtain the list of all blocks registered.
So if you want to disable just one block, then you have to get all blocks bu yourself...
Here's the list of core blocks:
core/cover-image)core/paragraph
core-embed/twitter
It's a lot easier to unregister given block in JS... In there you can use:
wp.blocks.unregisterBlockType( 'core/verse' );
core/cover-image has been changed to core/cover.
core-embed/* blocks no longer exist and are now block variations of core/embed. See my answer here: wordpress.stackexchange.com/a/379613/32946
There's a whitelist blocks removal example from the Gutenberg Handbook:
var allowedBlocks = [
'core/paragraph',
'core/image',
'core/html',
'core/freeform'
];
wp.blocks.getBlockTypes().forEach( function( blockType ) {
if ( allowedBlocks.indexOf( blockType.name ) === -1 ) {
wp.blocks.unregisterBlockType( blockType.name );
}
} );
One might try to modify it to remove blocks that do not start with core and are not part of allowedExtraBlocks (untested):
var allowedExtraBlocks = [
'my-plugin/block-example-1',
'my-plugin/block-example-2'
];
wp.blocks.getBlockTypes().forEach( function( blockType ) {
if ( ! blockType.name.startsWith( 'core' )
&& allowedExtraBlocks.indexOf( blockType.name ) === -1
) {
wp.blocks.unregisterBlockType( blockType.name );
}
} );
One could adjust this further to match block names that start with core/ or core-embed/ instead of core to be more precise.
The blacklist example wraps it with:
wp.domReady( function() {
// ...
} );
so this might be needed for the whitelist example too.
Here's a quick way to see available blocks on the editing page, in the browser's console:
In the 5.1 version there are 70 core blocks available, according to
wp.blocks.getBlockTypes().length;
The list of available block names:
wp.blocks.getBlockTypes().forEach( function( blockType ){ console.log( blockType.name ); });
Here's a table of available blocks:
console.table( wp.blocks.getBlockTypes() );
WP_Block_Type_Registry::get_instance()->get_all_registered() within the allowed_block_types filter callback, but it will probably not show all blocks there. @KrzysiekDróżdż
@birgire 's answer is very good. https://wordpress.stackexchange.com/a/326969/198298
Some information might be missing though.
As @birgire guesses, it really is necessary to wrap the code inside a
wp.domReady( function() {
// ...
} );
even if the script is loaded with the dependencies array( 'wp-blocks', 'wp-dom-ready', 'wp-edit-post' ) like it is recommended in the block filters guide.
Speaking of loading: If you're no plugin developer (like me) but only want to remove some block types for the users of your (company's) blog, you should load
the js file for this in your child-theme's functions.php like that:
/** Allow js-side adjustments to block editor (aka Gutenberg), i.e. remove certain block types. */
function my_childtheme_enqueue_block_editor_adj() {
wp_enqueue_script(
'block-editor-adjustments',
get_stylesheet_directory_uri() . '/js/block-editor-adjustments.js',
array( 'wp-blocks', 'wp-dom-ready', 'wp-edit-post' ),
);
}
add_action( 'enqueue_block_editor_assets', 'my_childtheme_enqueue_block_editor_adj' );
My js file looks like this:
wp.domReady(function () {
/**
* Remove some blocks from the block editor.
* This is not possible in php unfortunately.
*/
wp.blocks.unregisterBlockType('core/embed');
var allowedEmbedBlocks = [
'core-embed/twitter',
'core-embed/youtube',
'core-embed/facebook',
'core-embed/instagram',
'core-embed/wordpress',
'core-embed/flickr',
'core-embed/vimeo',
];
wp.blocks.getBlockTypes().forEach(function (blockType) {
if (blockType.name.startsWith('core-embed')
&& allowedEmbedBlocks.indexOf(blockType.name) === -1
) {
wp.blocks.unregisterBlockType(blockType.name);
}
});
});
This way I can now focus on the embed options in allowedEmbedBlocks regarding the Usercentrics data privacy settings.
core-embed does no longer exist in the latest version of the Gutenberg editor. All embeds now seem to be block variations of core/embed. So you cannot unregister the default core/embed block, because if you do, you will automatically unregister all its variations. However, you can unregister any variations with wp.blocks.unregisterBlockVariation(blockName, variationName).
Example: only allow the YouTube embed block:
wp.domReady( function() {
const allowedEmbedBlocks = [
'youtube',
];
wp.blocks.getBlockType( 'core/embed' ).variations.forEach( function( blockVariation ) {
if (
allowedEmbedBlocks.indexOf( blockVariation.name ) === -1
) {
wp.blocks.unregisterBlockVariation( 'core/embed', blockVariation.name );
}
} );
} );
(Sadly you will still be able to use the regular embed block as well. I'm not sure yet how this can be removed.)
You can follow this approach that I am using to disable custom blocks in the block editor. Just replace the array values with the blocks that you want to disable.
<?php
function disable_specific_blocks( $allowed_block_types, $post ) {
// An array of block names to disable
$disabled_blocks = array(
'core/table',
'core/image',
'core/gallery',
);
// Use this condition to disable blocks on certain post types, otherwise you can remove this IF condition
if ( $post->post_type === 'post' ) {
$allowed_block_types = array_diff( $allowed_block_types, $disabled_blocks );
}
return $allowed_block_types;
}
add_filter( 'allowed_block_types_all', 'disable_specific_blocks', 10, 2 );
?>
You can also follow this full guide on how to disable specific Gutenberg blocks on WordPress.
This is a one liner solution to remove all blocks that aren't of the core group:
wp.blocks.getBlockTypes()
.filter( b => ! b.name.startsWith('core') )
.forEach( b => wp.blocks.unregisterBlockType(b.name) )
I hope it will be useful to someone in the future!
Unregistering blocks can cause issues, especially if you operate using a whitelist instead of a blacklist. When an update switched the core/list block to use core/list-item inner blocks the editor just hard crashed.
I've found that removing blocks from the inserter is a safer tactic:
const visible_blocks = ["core/paragraph", "core/heading", "etc/etc"];
wp.hooks.addFilter("blocks.registerBlockType", "hideBlocks", (blockSettings, blockName) => {
// Return early in case something has gone wrong with this variable (otherwise the editor whitescreens)
if (visible_blocks === undefined || typeof visible_blocks !== "object") {
return blockSettings;
}
// Check and see if the block is one we want to hide
if (!visible_blocks.includes(blockName)) {
return Object.assign({}, blockSettings, {
// Otherwise hide the block from the inserter
supports: Object.assign({}, blockSettings.supports, { inserter: false }),
});
}
return blockSettings;
});
