How to use block_type_metadata filter in WordPress

block_type_metadata filter

Filters the metadata provided for registering a block type.

To use the block_type_metadata filter, first, you need to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.

In the examples below, we have defined a function weplugins_modify_block_type_metadata_defaults which takes 1 parameter and we registered it using add_filter. The first parameter block_type_metadata is the name of the hook, the second parameter weplugins_modify_block_type_metadata_defaults is the name of the function that 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 to the registered function.

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

Parameters

Below the 1 parameter is required to use this hook.

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

Live Examples

Example 1: Adding Custom Attribute to Core Group Block

Add custom ‘visibleOnMobile’ attribute to the core/group block.

    function weplugins_filter_block_type_metadata( $metadata ) {
        if ( 'core/group' === $metadata['name'] ) {
            $metadata['attributes']['visibleOnMobile'] = array(
                'type' => 'boolean',
            );
        }
        return $metadata;
    }
    add_filter( "block_type_metadata", "weplugins_filter_block_type_metadata", 10, 1 );
    

Example 2: Modifying Metadata Defaults

Update the metadata variable according to your website requirements and return this variable. You can modify the metadata variable conditionally too if you want.

    function weplugins_modify_block_type_metadata_defaults($metadata) {
        // Update the $metadata variable
        return $metadata;
    }
    // add the filter
    add_filter( "block_type_metadata", "weplugins_modify_block_type_metadata_defaults", 10, 1 );
    

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

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

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

Contact Us

If you’re having any trouble using this hook or need customizations, please contact us and we’d be happy to assist you.