How to use get_block_file_template filter in WordPress

get_block_file_template filter

Filters the array of queried block templates array after they’ve been fetched.

To use get_block_file_template 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_get_block_file_template_defaults which takes 3 parameters and we registered using add_filter. The first parameter get_block_file_template is name of the hook, The second parameter modify_get_block_file_template_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 get_block_file_template filter.

Parameters

Below are the 3 parameters are required to use this hook.

• $block_template : (WP_Block_Template|null) The found block template, or null if there is none.
• $id : (string) Template unique identifier (example: theme_slug//template_slug).
• $template_type : (string) Template type: ‘wp_template’ or ‘wp_template_part’.

Live Example

apply_filters( 'get_block_file_template', WP_Block_Template|null $block_template, string $id, string $template_type )

Below is an example how you can use this hook.

                        function modify_get_block_file_template_defaults($block_template, $id, $template_type) { 
   
                            // Update the $block_template variable according to your website requirements and return this variable. You can modify the $block_template variable conditionally too if you want.

                            return $block_template; 
                        }
                        // add the filter
                        add_filter( "get_block_file_template", "modify_get_block_file_template_defaults", 10, 3 );

To remove a hook callback, use the example below.

remove_filter( "get_block_file_template", "modify_get_block_file_template_defaults", 10, 3 );

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.