single_term_title() – Function | Developer.WordPress.org

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

$prefixstringoptional: What to display before the title.
Default:''
$displaybooloptional: Whether to display or retrieve title.
Default:true

Return

string|void Title when retrieving.

Source

function single_term_title( $prefix = '', $display = true ) {
	$term = get_queried_object();

	if ( ! $term ) {
		return;
	}

	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;
	}

	if ( empty( $term_name ) ) {
		return;
	}

	if ( $display ) {
		echo $prefix . $term_name;
	} else {
		return $prefix . $term_name;
	}
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘single_cat_title’, string $term_name ): Filters the category archive page title.
apply_filters( ‘single_tag_title’, string $term_name ): Filters the tag archive page title.
apply_filters( ‘single_term_title’, string $term_name ): Filters the custom taxonomy archive page title.

Uses	Description
is_category()`wp-includes/query.php`	Determines whether the query is for an existing category archive page.
is_tag()`wp-includes/query.php`	Determines whether the query is for an existing tag archive page.
is_tax()`wp-includes/query.php`	Determines whether the query is for an existing custom taxonomy archive page.
get_queried_object()`wp-includes/query.php`	Retrieves the currently queried object.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 1 more Show less

Used by	Description
wp_get_document_title()`wp-includes/general-template.php`	Returns document title for the current page.
get_the_archive_title()`wp-includes/general-template.php`	Retrieves the archive title based on the queried object.
wp_title()`wp-includes/general-template.php`	Displays or retrieves page title for all areas of blog.
single_cat_title()`wp-includes/general-template.php`	Displays or retrieves page title for category archive.
single_tag_title()`wp-includes/general-template.php`	Displays or retrieves page title for tag post archive.

Changelog

Version	Description
3.1.0	Introduced.

User Contributed Notes

Skip to note 3 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
This example displays the text “Currently browsing ” followed by the term title.
```
<p><?php single_term_title( 'Currently browsing ' ); ?>.</p>
```
Output:

Currently browsing WordPress.
Log in to add feedback
Skip to note 4 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
This example assigns the current term title to the variable $current_term for use in PHP.
```
$current_term = single_term_title( "", false );
```
Log in to add feedback

single_term_title( string $prefix = '', bool $display = true ): string|void

In this article