single_term_title( string $prefix = '', bool $display = true ): string|null
- Since
- 3.1.0
- Source
wp-includes/general-template.php:1605
Description
Useful for taxonomy term template files for displaying the taxonomy term page title.
The prefix does not automatically place a space between the prefix, so if there should be a space, the parameter value will need to have it at the end.
Compatibility
- WordPress
- since 3.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.
Parameters
$prefixstringoptional- What to display before the title.Default:
'' $displaybooloptional- Whether to display or retrieve title. Default true.Default:
true
Return value
string|null- Title when retrieving.
Performance profile
How much work a call to single_term_title() 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
- 7–29
- Plugin surface
- 3 hooks
- Called by
- 6
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 50.
Third-party callbacks on 'single_cat_title', 'single_tag_title', 'single_term_title' run inside this call, and their cost is not bounded by anything here.
6 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach query, option, 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 · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost single_term_title() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7 | get_queried_object() |
!is_category() && !is_tag() && !is_tax() | 16 | get_queried_object(), is_category(), is_tag(), is_tax() |
is_category() | 20–23 | get_queried_object(), is_category(), apply_filters() |
!is_category() && is_tag() | 23–26 | get_queried_object(), is_category(), is_tag(), apply_filters() |
!is_category() && !is_tag() && is_tax() | 26–29 | get_queried_object(), is_category(), is_tag(), is_tax(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 50 instructions, 7–29 executed per call, 6 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.
Hooks and filters fired · 3
3 hooks fire while single_term_title() runs, in this order:
- apply_filters( single_cat_title )filterline 1620 (+15 into the body)
Filters the category archive page title.
- apply_filters( single_tag_title )filterline 1629 (+24 into the body)
Filters the tag archive page title.
- apply_filters( single_term_title )filterline 1638 (+33 into the body)
Filters the custom taxonomy archive page title.
Uses · 5
- get_queried_object()Retrieves the currently queried object.
- is_category()Determines whether the query is for an existing category archive page.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- 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.
Used by · 6
- get_the_archive_title()Retrieves the archive title based on the queried object.
- single_cat_title()Displays or retrieves page title for category archive.
- single_tag_title()Displays or retrieves page title for tag post archive.
- twentynineteen_get_the_archive_title()Filters the default archive titles.
- wp_get_document_title()Returns document title for the current page.
- wp_title()Displays or retrieves page title for all areas of blog.
Source code
function single_term_title( $prefix = '', $display = true ) { $term = get_queried_object(); if ( ! $term ) { return null; } if ( is_category() ) { /** * Filters the category archive page title. * * @since 2.0.10 * * @param string $term_name Category name for archive being displayed. */ $term_name = apply_filters( 'single_cat_title', $term->name ); } elseif ( is_tag() ) { /** * Filters the tag archive page title. * * @since 2.3.0 * * @param string $term_name Tag name for archive being displayed. */ $term_name = apply_filters( 'single_tag_title', $term->name ); } elseif ( is_tax() ) { /** * Filters the custom taxonomy archive page title. * * @since 3.1.0 * * @param string $term_name Term name for archive being displayed. */ $term_name = apply_filters( 'single_term_title', $term->name ); } else { return null; } if ( empty( $term_name ) ) { return null; } if ( $display ) { echo $prefix . $term_name; } else { return $prefix . $term_name; }}Changelog
Introduced in 3.1.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
string|void to string|null.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/general-template.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.