This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.
allowed_block_types filter
Filters the allowed block types for the editor.
To use allowed_block_types filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.
We at WePlugins, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.
In the below live example, we have defined a function modify_allowed_block_types_defaults which takes 2 parameters and we registered using add_filter. The first parameter allowed_block_types is name of the hook, The second parameter modify_allowed_block_types_defaults is name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.
Sometimes, you have to remove a registered hook so you can use remove_filter to remove allowed_block_types filter.
Parameters
- $allowed_block_types: (bool|string[]) Array of block type slugs, or boolean to enable/disable all. Default true (all registered block types supported)
- $post: (WP_Post) The post resource data.
Below are the 2 parameters required to use this hook.
Live Example
Example 1: Limiting Block Types for Custom Post Types
In this example, we restrict block types for different custom post types.
function weplugins_allowed_block_types( $allowed_block_types, $post ) { switch( $post->post_type ) { case 'my_cpt_1': return array( 'core/paragraph' ); break; case 'my_cpt_2': return array( 'core/paragraph', 'core/heading' ); break; default: return true; } } add_filter( 'allowed_block_types', 'weplugins_allowed_block_types', 10, 2 );
Example 2: Modifying Allowed Block Types
Below is an example of how you can use this hook to modify allowed block types conditionally.
function weplugins_modify_allowed_block_types_defaults($allowed_block_types, $post) { // Update the $allowed_block_types variable according to your website requirements and return this variable. // You can modify the $allowed_block_types variable conditionally too if you want. return $allowed_block_types; } // add the filter add_filter( "allowed_block_types", "weplugins_modify_allowed_block_types_defaults", 10, 2 );
Example 3: Removing a Hook Callback
To remove a hook callback, use the example below. Make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.
remove_filter( "allowed_block_types", "weplugins_modify_allowed_block_types_defaults", 10, 2 );
Contact Us
If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.
Explore the latest in WordPress
Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.