How to use block_type_metadata filter in WordPress

block_type_metadata filter

Filters the metadata provided for registering a block type.

To use block_type_metadata 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 Flipper Code, 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_block_type_metadata_defaults which takes 1 parameters and we registered using add_filter. The first parameter block_type_metadata is name of the hook, The second parameter modify_block_type_metadata_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove block_type_metadata filter.

Parameters

Below the 1 parameter is required to use this hook.

• $metadata : (array) Metadata for registering a block type.

Live Example

/**
 * Add custom 'visibleOnMobile' attribute to the core/group block.
 *
 * @param array $metadata Metadata for registering a block type.
 * @return array
 */
function my_filter_block_type_metadata( $metadata ) {
    if ( 'core/group' === $metadata['name'] ) {
        $metadata['attributes']['visibleOnMobile'] = array(
            'type'    => 'boolean',

Below is an example how you can use this hook.

                        function modify_block_type_metadata_defaults($metadata) { 
   
                            // Update the $metadata variable according to your website requirements and return this variable. You can modify the $metadata variable conditionally too if you want.

                            return $metadata; 
                        }
                        // add the filter
                        add_filter( "block_type_metadata", "modify_block_type_metadata_defaults", 10, 1 );

To remove a hook callback, use the example below.

remove_filter( "block_type_metadata", "modify_block_type_metadata_defaults", 10, 1 );

Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.