single_term_title() – Display or retrieve page title for taxonomy term archive.

You appear to be a bot. Output may be restricted

Description

Display or retrieve page title for taxonomy term archive.

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.

Usage

$string|void = single_term_title( $prefix, $display );

Parameters

$prefix
( string ) optional – Optional. What to display before the title.
$display
( bool ) optional default: 1 – Optional. Whether to display or retrieve title. Default true.

Returns

string|void Title when retrieving.

Source

File name: wordpress/wp-includes/general-template.php
Lines:

1 to 48 of 48
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 on GitHub View on Trac