How to use get_block_templates filter in WordPress

get_block_templates filter

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

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

Parameters

Below are the 3 parameters required to use this hook.

• $query_result : (WP_Block_Template[]) Array of found block templates.
• $query : (array) Arguments to retrieve templates.
  ‘slug__in’
  (array) List of slugs to include.
  ‘wp_id’
  (int) Post ID of customized template.
• $template_type : (string) wp_template or wp_template_part.

Live Example

Example 1: Basic Usage

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

    function weplugins_modify_get_block_templates_defaults($query_result, $query, $template_type) { 
        // Update the $query_result variable according to your website requirements and return this variable. You can modify the $query_result variable conditionally too if you want.
        return $query_result; 
    }
    // add the filter
    add_filter( "get_block_templates", "weplugins_modify_get_block_templates_defaults", 10, 3 );
    

Example 2: Conditionally Modify Templates

In this example, we conditionally modify the block templates based on the template type.

    function weplugins_conditional_modify_get_block_templates($query_result, $query, $template_type) { 
        if ($template_type === 'wp_template_part') {
            // Modify $query_result for template parts
        }
        return $query_result; 
    }
    // add the filter
    add_filter( "get_block_templates", "weplugins_conditional_modify_get_block_templates", 10, 3 );
    

Example 3: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "get_block_templates", "weplugins_modify_get_block_templates_defaults", 10, 3 );
    

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