single_term_title( string $prefix = '', bool $display = true )
Displays or retrieves page title for taxonomy term archive.
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.
Parameters
- $prefix
-
(Optional) What to display before the title.
Default value: ''
- $display
-
(Optional) Whether to display or retrieve title.
Default value: true
Return
(string|void) Title when retrieving.
Source
File: wp-includes/general-template.php
function single_term_title( $prefix = '', $display = true ) {
$term = get_queried_object();
if ( !$term )
return;
if ( is_category() ) {
/**
* Filters the category archive page title.
*
* @since WP-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 WP-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 WP-3.1.0
*
* @param string $term_name Term name for archive being displayed.
*/
$term_name = apply_filters( 'single_term_title', $term->name );
} else {
return;
}
if ( empty( $term_name ) )
return;
if ( $display )
echo $prefix . $term_name;
else
return $prefix . $term_name;
}
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |