How to use pre_get_block_template filter in WordPress

pre_get_block_template filter

Return a non-null value to bypass the WordPress queries.

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

Parameters

Below are the 3 parameters required to use this hook.

• $block_template: (WP_Block_Template|null) Return block template object to short-circuit the default query, or null to allow WP to run its normal queries.
• $id: (string) Template unique identifier (example: theme_slug//template_slug).
• $template_type: (string) Template type: ‘wp_template’ or ‘wp_template_part’.

Live Example 1

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

    function weplugins_modify_pre_get_block_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( "pre_get_block_template", "weplugins_modify_pre_get_block_template_defaults", 10, 3 );
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter( "pre_get_block_template", "weplugins_modify_pre_get_block_template_defaults", 10, 3 );
    

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

Live Example 3

Another example of using the pre_get_block_template filter in a more complex scenario.

    function weplugins_custom_block_template($block_template, $id, $template_type) {
        if ($template_type == 'wp_template_part') {
            // Custom logic for template part
            $block_template->content = '<!-- wp:paragraph --><p>Custom Template Part</p><!-- /wp:paragraph -->';
        }
        return $block_template;
    }
    add_filter('pre_get_block_template', 'weplugins_custom_block_template', 10, 3);
    

Contact Us

If you’re having any trouble using this hook, please Contact Us and we’d be happy to assist you.