How to use block_type_metadata_settings filter in WordPress

block_type_metadata_settings filter

Filters the settings determined from the block type metadata.

To use block_type_metadata_settings 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 weplugins_modify_block_type_metadata_settings_defaults which takes 2 parameters and we registered using add_filter. The first parameter block_type_metadata_settings is the name of the hook, the second parameter weplugins_modify_block_type_metadata_settings_defaults is the 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.

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

Parameters

• $settings: (array) Array of determined settings for registering a block type.
• $metadata: (array) Metadata provided for registering a block type.

Example 1: Basic Usage

This example demonstrates how to apply the filter with basic modifications.

    function weplugins_modify_block_type_metadata_settings_defaults($settings, $metadata) { 
        // Update the $settings variable according to your website requirements and return this variable.
        return $settings; 
    }
    // add the filter
    add_filter( "block_type_metadata_settings", "weplugins_modify_block_type_metadata_settings_defaults", 10, 2 );
    

Example 2: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "block_type_metadata_settings", "weplugins_modify_block_type_metadata_settings_defaults", 10, 2 );
    

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

Example 3: Conditional Modification

Here’s how you can modify the settings conditionally based on metadata.

    function weplugins_modify_block_type_metadata_settings_conditionally($settings, $metadata) { 
        if (isset($metadata['condition_key']) && $metadata['condition_key'] === 'specific_value') {
            $settings['new_setting'] = 'value';
        }
        return $settings; 
    }
    // add the filter with conditional logic
    add_filter( "block_type_metadata_settings", "weplugins_modify_block_type_metadata_settings_conditionally", 10, 2 );
    

Contact Us

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