_get_block_templates_files( string $template_type, array $query = array() ): array|null

Compatibility

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

Parameters

$template_typestring

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

$queryarrayoptional

Arguments to retrieve templates. Optional, empty by default.Default: array()

• $slug__instring[]

  List of slugs to include.

• $slug__not_instring[]

  List of slugs to skip.

• $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.

Return value

array|null

Template files on success, null if $template_type is not matched.

Performance profile

How much work a call to _get_block_templates_files() 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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

41–55

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 142.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters()one call below _get_block_templates_files()
• optionoption read or writeget_option()one call below _get_block_templates_files()

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

What one call costs · 4 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 9

• get_default_block_template_types()Returns a filtered list of default template types, containing their localized titles and descriptions.
• get_stylesheet()Retrieves name of the current stylesheet.
• get_template()Retrieves name of the active theme.
• get_stylesheet_directory()Retrieves stylesheet directory path for the active theme.
• get_template_directory()Retrieves template directory path for the active theme.
• get_block_theme_folders()For backward compatibility reasons, block themes might be using block-templates or block-template-parts, this function ensures we fallback to these folders properly.
• _get_block_templates_paths()Finds all nested template part file paths in a theme's directory.
• _add_block_template_part_area_info()Attempts to add the template part's area information to the input template.
• _add_block_template_info()Attempts to add custom template information to the template item.

Used by · 1

• get_block_templates()Retrieves a list of unified template objects based on a query.

Source code

View on Trac ↗View on GitHub ↗

374function _get_block_templates_files( $template_type, $query = array() ) {375	if ( 'wp_template' !== $template_type && 'wp_template_part' !== $template_type ) {376		return null;377	}378 379	$default_template_types = array();380	if ( 'wp_template' === $template_type ) {381		$default_template_types = get_default_block_template_types();382	}383 384	// Prepare metadata from $query.385	$slugs_to_include = isset( $query['slug__in'] ) ? $query['slug__in'] : array();386	$slugs_to_skip    = isset( $query['slug__not_in'] ) ? $query['slug__not_in'] : array();387	$area             = isset( $query['area'] ) ? $query['area'] : null;388	$post_type        = isset( $query['post_type'] ) ? $query['post_type'] : '';389 390	$stylesheet = get_stylesheet();391	$template   = get_template();392	$themes     = array(393		$stylesheet => get_stylesheet_directory(),394	);395	// Add the parent theme if it's not the same as the current theme.396	if ( $stylesheet !== $template ) {397		$themes[ $template ] = get_template_directory();398	}399	$template_files = array();400	foreach ( $themes as $theme_slug => $theme_dir ) {401		$template_base_paths  = get_block_theme_folders( $theme_slug );402		$theme_template_files = _get_block_templates_paths( $theme_dir . '/' . $template_base_paths[ $template_type ] );403		foreach ( $theme_template_files as $template_file ) {404			$template_base_path = $template_base_paths[ $template_type ];405			$template_slug      = substr(406				$template_file,407				// Starting position of slug.408				strpos( $template_file, $template_base_path . DIRECTORY_SEPARATOR ) + 1 + strlen( $template_base_path ),409				// Subtract ending '.html'.410				-5411			);412 413			// Skip this item if its slug doesn't match any of the slugs to include.414			if ( ! empty( $slugs_to_include ) && ! in_array( $template_slug, $slugs_to_include, true ) ) {415				continue;416			}417 418			// Skip this item if its slug matches any of the slugs to skip.419			if ( ! empty( $slugs_to_skip ) && in_array( $template_slug, $slugs_to_skip, true ) ) {420				continue;421			}422 423			/*424			 * The child theme items (stylesheet) are processed before the parent theme's (template).425			 * If a child theme defines a template, prevent the parent template from being added to the list as well.426			 */427			if ( isset( $template_files[ $template_slug ] ) ) {428				continue;429			}430 431			$new_template_item = array(432				'slug'  => $template_slug,433				'path'  => $template_file,434				'theme' => $theme_slug,435				'type'  => $template_type,436			);437 438			if ( 'wp_template_part' === $template_type ) {439				$candidate = _add_block_template_part_area_info( $new_template_item );440				if ( ! isset( $area ) || $area === $candidate['area'] ) {441					$template_files[ $template_slug ] = $candidate;442				}443			}444 445			if ( 'wp_template' === $template_type ) {446				$candidate = _add_block_template_info( $new_template_item );447				$is_custom = ! isset( $default_template_types[ $candidate['slug'] ] );448 449				if (450					! $post_type ||451					( $post_type && isset( $candidate['postTypes'] ) && in_array( $post_type, $candidate['postTypes'], true ) )452				) {453					$template_files[ $template_slug ] = $candidate;

Changelog

Introduced in 5.9.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.