WP_Block_Templates_Registry::get_by_query( array $query = array() ): WP_Block_Template[]
- Since
- 6.7.0
- Source
wp-includes/class-wp-block-templates-registry.php:160
Compatibility
- WordPress
- since 6.7.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
$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.$post_typestringPost type to get the templates for.
Return value
WP_Block_Template[]- Associative array of
$template_name => $templatepairs.
Performance profile
How much work a call to WP_Block_Templates_Registry::get_by_query() 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
- 6–18
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 38.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
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 WP_Block_Templates_Registry::get_by_query() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6 | ->get_all_registered() |
| always | 17–18 | ->get_all_registered(), wp_parse_args() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 38 | 6–18 | 9 | |
| 8.5 | 38 | 6–18 | 9 | |
| 8.4 | 38 | 6–18 | 9 | 9 fewer instructions than PHP 8.3 |
| 8.3 | 47 | 6–18 | 9 | |
| 8.2 | 47 | 6–18 | 9 | |
| 8.1 | 47 | 6–18 | 9 | |
| 7.4 | 47 | 6–18 | 9 |
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 · 2
- wp_parse_args()Merges user defined arguments into defaults array.
- WP_Block_Templates_Registry::get_all_registered()Retrieves all registered templates.
Source code
public function get_by_query( $query = array() ) { $all_templates = $this->get_all_registered(); if ( ! $all_templates ) { return array(); } $query = wp_parse_args( $query, array( 'slug__in' => array(), 'slug__not_in' => array(), 'post_type' => '', ) ); $slugs_to_include = $query['slug__in']; $slugs_to_skip = $query['slug__not_in']; $post_type = $query['post_type']; $matching_templates = array(); foreach ( $all_templates as $template_name => $template ) { if ( $slugs_to_include && ! in_array( $template->slug, $slugs_to_include, true ) ) { continue; } if ( $slugs_to_skip && in_array( $template->slug, $slugs_to_skip, true ) ) { continue; } if ( $post_type && ! in_array( $post_type, $template->post_types, true ) ) { continue; } $matching_templates[ $template_name ] = $template; } return $matching_templates; }Changelog
Introduced in 6.7.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/class-wp-block-templates-registry.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.