render_block_core_term_description( array $attributes ): string
- Since
- 5.9.0
- Source
wp-includes/blocks/term-description.php:17
core/term-description block on the server.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
$attributesarray- Block attributes.
Return value
string- Returns the description of the current taxonomy term, if available
Performance profile
How much work a call to render_block_core_term_description() 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
- Scaling
- Constant
- Instructions
- 11–42
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
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 43.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost render_block_core_term_description() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_category() && empty($term_description) | 11 | is_category(), term_description() |
!is_category() && is_tag() && empty($term_description) | 14 | is_category(), is_tag(), term_description() |
!is_category() && !is_tag() && !is_tax() && empty($term_description) | 14 | is_category(), is_tag(), is_tax() |
!is_category() && !is_tag() && is_tax() && empty($term_description) | 17 | is_category(), is_tag(), is_tax(), term_description() |
is_category() && !empty($term_description) | 30–36 | is_category(), term_description(), class() |
!is_category() && is_tag() && !empty($term_description) | 33–39 | is_category(), is_tag(), term_description(), class() |
!is_category() && !is_tag() && !is_tax() && !empty($term_description) | 33–39 | is_category(), is_tag(), is_tax(), class() |
!is_category() && !is_tag() && is_tax() && !empty($term_description) | 36–42 | is_category(), is_tag(), is_tax(), term_description(), class() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 43 | 11–42 | 6 | |
| 8.5 | 43 | 11–42 | 6 | |
| 8.4 | 43 | 11–42 | 6 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 46 | 11–45 | 6 | |
| 8.2 | 46 | 11–45 | 6 | |
| 8.1 | 46 | 11–45 | 6 | |
| 7.4 | 46 | 11–45 | 6 |
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
- is_category()Determines whether the query is for an existing category archive page.
- is_tag()Determines whether the query is for an existing tag archive page.
- is_tax()Determines whether the query is for an existing custom taxonomy archive page.
- term_description()Retrieves term description.
- 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.
Source code
function render_block_core_term_description( $attributes ) { $term_description = ''; if ( is_category() || is_tag() || is_tax() ) { $term_description = term_description(); } if ( empty( $term_description ) ) { return ''; } $classes = array(); if ( isset( $attributes['textAlign'] ) ) { $classes[] = 'has-text-align-' . $attributes['textAlign']; } if ( isset( $attributes['style']['elements']['link']['color']['text'] ) ) { $classes[] = 'has-link-color'; } $wrapper_attributes = get_block_wrapper_attributes( array( 'class' => implode( ' ', $classes ) ) ); return '<div ' . $wrapper_attributes . '>' . $term_description . '</div>';}Changelog
Introduced in 5.9.0. 2 changes between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$content added.verified against source$block added.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/blocks/term-description.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.