single_term_title() — описание функции WordPress на русском

Сигнатура

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

Описание

Полезно для файлов шаблонов терминов таксономии для отображения заголовка страницы термина таксономии.
Prefix не добавляет пробел автоматически, поэтому, если пробел нужен, его следует указать в конце значения параметра.

Оригинал (английский)

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.

Параметры

$prefix string необязательный = ''

Что отображать перед заголовком.

$display bool необязательный = true

Отображать или получать заголовок.

Возвращаемое значение

string|null

Исходный код

wp-includes/general-template.php:1605

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

История изменений

Версия	Описание
3.1.0	Introduced.