wppaste
WordPress

get_block_theme_folders( string $theme_stylesheet = null ): string[]

Since
5.9.0
Source
wp-includes/block-template-utils.php:39
For backward compatibility reasons, block themes might be using block-templates or block-template-parts, this function ensures we fallback to these folders properly.

Compatibility

WordPress
since 5.9.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$theme_stylesheetstringoptional
The stylesheet. Default is to leverage the main theme root.Default: null

Return value

string[]
Folder names used by block themes.

  • $wp_templatestring

    Theme-relative directory name for block templates.

  • $wp_template_partstring

    Theme-relative directory name for block template parts.

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
10–12

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!->exists()10wp_get_theme(), ->exists()
->exists()12wp_get_theme(), ->exists(), ->get_block_template_folders()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 13 instructions, 10–12 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Used by · 2

Source code

View on Trac View on GitHub 

function get_block_theme_folders( $theme_stylesheet = null ) {	$theme = wp_get_theme( (string) $theme_stylesheet );	if ( ! $theme->exists() ) {		// Return the default folders if the theme doesn't exist.		return array(			'wp_template'      => 'templates',			'wp_template_part' => 'parts',		);	}	return $theme->get_block_template_folders();}

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.