render_block_core_query_total( array $attributes, string $content, WP_Block $block ): string
- Since
- 6.8.0
- Source
wp-includes/blocks/query-total.php:21
query-total block on the server.Compatibility
- WordPress
- since 6.8.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 4 of the 5 tracked releases, added in 6.8.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$attributesarray- Block attributes.
$contentstring- Block default content.
$blockWP_Block- Block instance.
Return value
string- The rendered block content.
Performance profile
How much work a call to render_block_core_query_total() 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
- Moderate
- Scaling
- Constant
- Instructions
- 52–73
- Plugin surface
- None
- Called by
- 0
Reads stored settings via get_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 106.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- optionoption read or write
get_option()one call below render_block_core_query_total() - hookthird-party callbacks
apply_filters()one call below render_block_core_query_total()
Further down the call graph this can also reach cache, serialize, query 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 render_block_core_query_total() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 52–58 | get_block_wrapper_attributes(), get_query_var(), ->get(), _n(), sprintf(), sprintf() |
| always | 54–59 | get_block_wrapper_attributes(), get_query_var(), ->get(), __(), sprintf(), sprintf() |
| always | 61–72 | get_block_wrapper_attributes(), build_query_vars_from_query_block(), ->get(), _n(), sprintf(), sprintf() |
| always | 63–73 | get_block_wrapper_attributes(), build_query_vars_from_query_block(), ->get(), __(), sprintf(), sprintf() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 106 | 52–73 | 8 | |
| 8.5 | 106 | 52–73 | 8 | |
| 8.4 | 106 | 52–73 | 8 | 8 fewer instructions than PHP 8.3 |
| 8.3 | 114 | 60–77 | 8 | |
| 8.2 | 114 | 60–77 | 8 | |
| 8.1 | 114 | 60–77 | 8 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 116 | 60–79 | 8 |
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 · 6
- get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.
- get_query_var()Retrieves the value of a query variable in the WP_Query class.
- build_query_vars_from_query_block()Helper function that constructs a WP_Query args array from a `Query` block properties.
- __()Retrieves the translation of $text.
- _n()Translates and retrieves the singular or plural form based on the supplied number.
- WP_Query::__construct()Constructor.
Source code
function render_block_core_query_total( $attributes, $content, $block ) { global $wp_query; $wrapper_attributes = get_block_wrapper_attributes(); if ( $block->context['query']['inherit'] ?? false ) { $query_to_use = $wp_query; $current_page = max( 1, (int) get_query_var( 'paged', 1 ) ); } else { $page_key = isset( $block->context['queryId'] ) ? 'query-' . $block->context['queryId'] . '-page' : 'query-page'; $current_page = (int) ( $_GET[ $page_key ] ?? 1 ); $query_to_use = new WP_Query( build_query_vars_from_query_block( $block, $current_page ) ); } $max_rows = $query_to_use->found_posts; $posts_per_page = (int) $query_to_use->get( 'posts_per_page' ); // Calculate the range of posts being displayed. $start = ( 0 === $max_rows ) ? 0 : ( ( $current_page - 1 ) * $posts_per_page + 1 ); $end = min( $start + $posts_per_page - 1, $max_rows ); // Prepare the display based on the `displayType` attribute. $output = ''; switch ( $attributes['displayType'] ) { case 'range-display': if ( $start === $end ) { $output = sprintf( /* translators: 1: Start index of posts, 2: Total number of posts */ __( 'Displaying %1$s of %2$s' ), $start, $max_rows ); } else { $output = sprintf( /* translators: 1: Start index of posts, 2: End index of posts, 3: Total number of posts */ __( 'Displaying %1$s – %2$s of %3$s' ), $start, $end, $max_rows ); } break; case 'total-results': default: // translators: %d: number of results. $output = sprintf( _n( '%d result found', '%d results found', $max_rows ), $max_rows ); break; } return sprintf( '<div %1$s>%2$s</div>', $wrapper_attributes, $output );}Changelog
Introduced in 6.8.0. Unchanged from 6.8.8 through 7.1.0.
Signature, return type and hooks compared across 4 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/blocks/query-total.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.