build_template_part_block_instance_variations(): array
- Since
- 6.1.0
- Source
wp-includes/blocks/template-part.php:216
Compatibility
- WordPress
- since 6.1.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.
Return value
array- Array containing the block variation objects.
Performance profile
How much work a call to build_template_part_block_instance_variations() 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
- Light
- Scaling
- Scales with input
- Instructions
- 4–37
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 83.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below build_template_part_block_instance_variations()
Further down the call graph this can also reach option, query, 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost build_template_part_block_instance_variations() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
wp_installing() | 4 | wp_installing() |
!wp_installing() && !current_theme_supports() | 12 | wp_installing(), current_theme_supports(), current_theme_supports() |
!wp_installing() && current_theme_supports() | 32–33 | wp_installing(), current_theme_supports(), get_block_templates(), get_allowed_block_template_part_areas(), array_column(), array_column(), array_combine() |
!wp_installing() | 36–37 | wp_installing(), current_theme_supports(), current_theme_supports(), get_block_templates(), get_allowed_block_template_part_areas(), array_column(), array_column(), array_combine() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 83 instructions, 4–37 executed per call, 8 branches. 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 · 5
- wp_installing()Checks or sets whether WordPress is in "installation" mode.
- current_theme_supports()Checks a theme's support for a given feature.
- get_block_templates()Retrieves a list of unified template objects based on a query.
- get_allowed_block_template_part_areas()Returns a filtered list of allowed area values for template parts.
- sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
Used by · 1
- build_template_part_block_variations()Returns an array of all template part block variations.
Source code
function build_template_part_block_instance_variations() { // Block themes are unavailable during installation. if ( wp_installing() ) { return array(); } if ( ! current_theme_supports( 'block-templates' ) && ! current_theme_supports( 'block-template-parts' ) ) { return array(); } $variations = array(); $template_parts = get_block_templates( array( 'post_type' => 'wp_template_part', ), 'wp_template_part' ); $defined_areas = get_allowed_block_template_part_areas(); $icon_by_area = array_combine( array_column( $defined_areas, 'area' ), array_column( $defined_areas, 'icon' ) ); foreach ( $template_parts as $template_part ) { // Navigation overlay template parts should not appear in the // general inserter. They are managed through the Navigation // block's overlay template part selector. $scope = ( 'navigation-overlay' === $template_part->area ) ? array() : array( 'inserter' ); $variations[] = array( 'name' => 'instance_' . sanitize_title( $template_part->slug ), 'title' => $template_part->title, // If there's no description for the template part don't show the // block description. This is a bit hacky, but prevent the fallback // by using a non-breaking space so that the value of description // isn't falsey. 'description' => $template_part->description || ' ', 'attributes' => array( 'slug' => $template_part->slug, 'theme' => $template_part->theme, 'area' => $template_part->area, ), 'scope' => $scope, 'icon' => $icon_by_area[ $template_part->area ] ?? null, 'example' => array( 'attributes' => array( 'slug' => $template_part->slug, 'theme' => $template_part->theme, 'area' => $template_part->area, ), ), ); } return $variations;}Changelog
Introduced in 6.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/blocks/template-part.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.