get_block_templates( array $query = array(), string $template_type = 'wp_template' ): WP_Block_Template[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$queryarrayoptional

Arguments to retrieve templates.Default: array()

• $slug__instring[]

  List of slugs to include.

• $wp_idint

  Post ID of customized template.

• $areastring

  A 'wp_template_part_area' taxonomy value to filter by (for 'wp_template_part' template type only).

• $post_typestring

  Post type to get the templates for.

$template_typestringoptional

Template type. Either 'wp_template' or 'wp_template_part'.Default: 'wp_template'

Return value

WP_Block_Template[]

Array of block templates.

Performance profile

How much work a call to get_block_templates() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11

Executed per call on PHP 8.5. The body compiles to 201.

Plugin surface

2 hooks

Third-party callbacks on 'pre_get_block_templates', 'get_block_templates' run inside this call, and their cost is not bounded by anything here.

Called by

7

7 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below get_block_templates()
• querycontent queryget_post()one call below get_block_templates()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_block_templates() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while get_block_templates() runs, in this order:

1. 1
   apply_filters( pre_get_block_templates )filterline 1113 (+20 into the body)

   Filters the block templates array before the query takes place.

2. 2
   apply_filters( get_block_templates )filterline 1263 (+170 into the body)

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

Uses · 12

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_stylesheet()Retrieves name of the current stylesheet.
• _build_block_template_result_from_post()Builds a unified template object based a post Object.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• _get_block_templates_files()Retrieves the template files from the theme.
• _build_block_template_result_from_file()Builds a unified template object based on a theme file.
• get_default_block_template_types()Returns a filtered list of default template types, containing their localized titles and descriptions.
• apply_block_hooks_to_content()Runs the hooked blocks algorithm on the given content.
• WP_Query::__construct()Constructor.
• WP_Block_Templates_Registry::get_instance()::get_by_query()
• WP_Block_Templates_Registry::get_instance()Utility method to retrieve the main instance of the class.

Used by · 7

• WP_REST_Templates_Controller::create_item()Creates a single template.
• WP_REST_Templates_Controller::get_items()Returns a list of templates.
• WP_Theme::get_post_templates()Returns the theme's post templates.
• build_template_part_block_instance_variations()Returns an array of instance variation objects for the template part block
• resolve_block_template()Returns the correct 'wp_template' to render for the request template type.
• wp_generate_block_templates_export_file()Creates an export of the current templates and template parts from the site editor at the specified path in a ZIP file.
• wp_get_post_content_block_attributes()Retrieves Post Content block attributes from the current post template.

Source code

View on Trac ↗View on GitHub ↗

1093function get_block_templates( $query = array(), $template_type = 'wp_template' ) {1094	/**1095	 * Filters the block templates array before the query takes place.1096	 *1097	 * Return a non-null value to bypass the WordPress queries.1098	 *1099	 * @since 5.9.01100	 *1101	 * @param WP_Block_Template[]|null $block_templates Return an array of block templates to short-circuit the default query,1102	 *                                                  or null to allow WP to run its normal queries.1103	 * @param array  $query {1104	 *     Arguments to retrieve templates. All arguments are optional.1105	 *1106	 *     @type string[] $slug__in  List of slugs to include.1107	 *     @type int      $wp_id     Post ID of customized template.1108	 *     @type string   $area      A 'wp_template_part_area' taxonomy value to filter by (for 'wp_template_part' template type only).1109	 *     @type string   $post_type Post type to get the templates for.1110	 * }1111	 * @param string $template_type Template type. Either 'wp_template' or 'wp_template_part'.1112	 */1113	$templates = apply_filters( 'pre_get_block_templates', null, $query, $template_type );1114	if ( ! is_null( $templates ) ) {1115		return $templates;1116	}1117 1118	$post_type     = isset( $query['post_type'] ) ? $query['post_type'] : '';1119	$wp_query_args = array(1120		'post_status'         => array( 'auto-draft', 'draft', 'publish' ),1121		'post_type'           => $template_type,1122		'posts_per_page'      => -1,1123		'no_found_rows'       => true,1124		'lazy_load_term_meta' => false,1125		'tax_query'           => array(1126			array(1127				'taxonomy' => 'wp_theme',1128				'field'    => 'name',1129				'terms'    => get_stylesheet(),1130			),1131		),1132	);1133 1134	if ( 'wp_template_part' === $template_type && isset( $query['area'] ) ) {1135		$wp_query_args['tax_query'][]           = array(1136			'taxonomy' => 'wp_template_part_area',1137			'field'    => 'name',1138			'terms'    => $query['area'],1139		);1140		$wp_query_args['tax_query']['relation'] = 'AND';1141	}1142 1143	if ( ! empty( $query['slug__in'] ) ) {1144		$wp_query_args['post_name__in']  = $query['slug__in'];1145		$wp_query_args['posts_per_page'] = count( array_unique( $query['slug__in'] ) );1146	}1147 1148	// This is only needed for the regular templates/template parts post type listing and editor.1149	if ( isset( $query['wp_id'] ) ) {1150		$wp_query_args['p'] = $query['wp_id'];1151	} else {1152		$wp_query_args['post_status'] = 'publish';1153	}1154 1155	$template_query = new WP_Query( $wp_query_args );1156	$query_result   = array();1157	foreach ( $template_query->posts as $post ) {1158		$template = _build_block_template_result_from_post( $post );1159 1160		if ( is_wp_error( $template ) ) {1161			continue;1162		}1163 1164		if ( $post_type && ! $template->is_custom ) {1165			continue;1166		}1167 1168		if (1169			$post_type &&1170			isset( $template->post_types ) &&1171			! in_array( $post_type, $template->post_types, true )1172		) {

Changelog

Introduced in 5.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/block-template-utils.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.