get_block_file_template │ filter-hook │ WP 5.9.0

Filters the block template object after it has been (potentially) fetched from the theme file.

Usage

add_filter( 'get_block_file_template', 'wp_kama_get_block_file_template_filter', 10, 3 );

/**
 * Function for `get_block_file_template` filter-hook.
 * 
 * @param WP_Block_Template|null $block_template The found block template, or null if there is none.
 * @param string                 $id             Template unique identifier (example: 'theme_slug//template_slug').
 * @param string                 $template_type  Template type. Either 'wp_template' or 'wp_template_part'.
 *
 * @return WP_Block_Template|null
 */
function wp_kama_get_block_file_template_filter( $block_template, $id, $template_type ){

	// filter...
	return $block_template;
}

$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. Either 'wp_template' or 'wp_template_part'.

Changelog

Where the hook is called

return apply_filters( 'get_block_file_template', $block_template, $id, $template_type );

return apply_filters( 'get_block_file_template', null, $id, $template_type );

return apply_filters( 'get_block_file_template', $block_template, $id, $template_type );

Where the hook is used in WordPress