post_type_archive_title() │ WP 3.1.0

Выводит или возвращает заголовок для архивной страницы произвольного типа постов.

Этот Тег шаблона предназначен для использования на страницах, который выводятся файлами шаблона: archive.php и archive-{posttype}.php.

Основа для: wp_get_document_title()
Хуки из функции

Возвращает

Строку|null.

Использование

<?php post_type_archive_title( $prefix, $display ); ?>
$prefix(строка)
Текст, который будет перед заголовком.
По умолчанию: ''
$display(логический)
true — выведет на экран, false — просто, вернет для обработки.
По умолчанию: true

Примеры

0

#1 Как работает функция

Допустим у нас есть зарегистрированный тип записи (см. register_post_type()) movie у которого параметр lable равен "фильмы" и параметр has_archive равен true (т.е. у типа есть архивная страница). Теперь, если мы вызовем эту функцию на странице архива http://example.com/movie, то мы должны увидеть следующий заголовок:

<?php post_type_archive_title('Записи типа: '); ?>

Выведет: "Записи типа: Фильмы"

Список изменений

С версии 3.1.0 Введена.

Код post_type_archive_title() WP 6.1.1

wp-includes/general-template.php 
function post_type_archive_title( $prefix = '', $display = true ) {
	if ( ! is_post_type_archive() ) {
		return;
	}

	$post_type = get_query_var( 'post_type' );
	if ( is_array( $post_type ) ) {
		$post_type = reset( $post_type );
	}

	$post_type_obj = get_post_type_object( $post_type );

	/**
	 * Filters the post type archive title.
	 *
	 * @since 3.1.0
	 *
	 * @param string $post_type_name Post type 'name' label.
	 * @param string $post_type      Post type.
	 */
	$title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type );

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

archive (архивы записей)

Типы записей

Основные