How to use register_block_type_args filter in WordPress

register_block_type_args filter

Filters the arguments for registering a block type.

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

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

Parameters

Below are the 2 parameters required to use this hook.

• $args : (array) Array of arguments for registering a block type.
• $block_type : (string) Block type name including namespace.

Live Example

apply_filters( 'register_block_type_args', array $args, string $block_type )

Below is an example of how you can use this hook.

Example 1: Modifying Block Type Args

In this example, we are modifying the block type arguments before they are registered.

    function weplugins_modify_register_block_type_args_defaults($args, $block_type) { 
        // Update the $args variable according to your website requirements and return this variable. You can modify the $args variable conditionally too if you want.
        return $args; 
    }
    // add the filter
    add_filter( "register_block_type_args", "weplugins_modify_register_block_type_args_defaults", 10, 2 );
    

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "register_block_type_args", "weplugins_modify_register_block_type_args_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 of Args

In this example, we conditionally modify the arguments for a specific block type.

    function weplugins_conditional_modify_block_type_args($args, $block_type) {
        if ($block_type == 'weplugins/special-block') {
            // Modify $args for the special block
            $args['special_setting'] = true;
        }
        return $args;
    }
    // add the filter
    add_filter( "register_block_type_args", "weplugins_conditional_modify_block_type_args", 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.