wp_get_document_title()WP 4.4.0

Получает заголовок текущей страницы (документа), который принято выводить в html теге <title>.

Это замена для устаревшей функции wp_title().

В конце заголовка добавляется — название сайта. На главной странице вместо названия выводится — описание сайта. Главная страница определяется так: is_home() && is_front_page(). Для страниц пагинации в конце будет добавлен номер страницы: – Страница 2.

Эта функция сработает в <head> части HTML автоматически, если у темы включена поддержка title-tag:

add_theme_support( 'title-tag' );

В этом случае в <head> будет добавлена такая конструкция:

<title><?php echo wp_get_document_title(); ?></title>

Соответственно в современных темах WP вообще не нужно добавлять тег <title> в <head>, он будет добавлен автоматически. Добавит его функция _wp_render_title_tag(), которая сработает на хуке wp_head, который в свою очередь вызывается функцией wp_head().

Работу этой функции можно переопределить через хук pre_get_document_title:

$title = apply_filters( 'pre_get_document_title', '' );
if ( ! empty( $title ) ) {
	return $title;
}

См. пример 3.

Используйте фильтры:

  • document_title_parts, чтобы изменить любую часть заголовка выводимого этой функцией.
  • document_title, чтобы изменить итоговую строку заголовка.
1 раз — 0.00042 сек (быстро) | 50000 раз — 15 сек (медленно)

Возвращает

Строку. Заголовок текущей страницы.

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

<title><?php echo wp_get_document_title(); ?></title>

Примеры

0

#1 Демонстрация работы

Допустим мы находимся на странице "Контакты":

echo wp_get_document_title();
// выведет: Контакты - Название сайта
0

#2 Вывод TITLE заголовка страницы

Это замена для тега шаблона wp_title(). Используется в header.php для вывода заголовка любой страницы.

Это демонстрационный пример, на деле в WP этот код выполняется функцией _wp_render_title_tag(), которая в свою очередь зацеплена на хук wp_head. Т.е. код выполняется в HEAD части HTML и чтобы его включить, нужно включить поддержку темы title-tag.

<title><?php echo wp_get_document_title(); ?></title>
0

#3 Выведем свой заголовок, используя фильтр

Допустим нам нужно чтобы эта функцию вообще не работала и через нее мы хотим вывести свой заголовок, например "Моя страница", на странице с ID 20:

// На странице 20 будет выведен заголовок "Моя страница"
add_filter( 'pre_get_document_title', function(){
	global $post;

	if( $post->ID != 20 )
		return ''; // не меняем ничего

	return 'Моя страница';
} );
0

#4 Переопределяем функцию

Можно написать свою функцию и полностью заменить работу этой функции:

add_filter( 'pre_get_document_title', 'my_get_document_title' );
function my_get_document_title(){
	// Генерируем динамический заголовок для каждой страницы.
	// За основу можно взять код этой функции и поправить его под себя.

	$title = 'Это динамически созданный заголовок';

	return $title;
}
0

#5 Изменим разделитель между заголовком и названием сайта

По умолчанию функция добавляет в после заголовка название сайта через разделитель: ' - '. Разделитель можно изменить через фильтр:

add_filter( 'document_title_separator', function(){
	return ' | ';
} );
0

#6 Удалим названия сайта в конце заголовка

Ко всем заголовкам на отдельных страницах is_singular() добавляется название сайта, через разделитель. Это не всегда хорошо, давайте поправим этот момент. Для этого используем фильтр: document_title_parts:

// Удалим названия сайта в конце заголовка
add_filter( 'document_title_parts', function( $parts ){

	if( isset( $parts['site'] ) ){
		unset( $parts['site'] );
	}

	return $parts;
} );
0

#7 Удалим описания сайта из заголовка главной страницы

На главной странице выводиться "Название сайта - описание сайта". Чтобы удалить описание и выводить только называние, используйте такой хук:

// удалим описание из заголовка для главной страницы
add_filter( 'document_title_parts', function( $title ){

	if( isset( $title['tagline'] ) ){
		unset( $title['tagline'] );
	}

	return $title;
} );

Заметки

  • Global. int. $page Page number of a single post.
  • Global. int. $paged Page number of a list of posts.

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

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

Код wp_get_document_title() WP 6.4.3

function wp_get_document_title() {

	/**
	 * Filters the document title before it is generated.
	 *
	 * Passing a non-empty value will short-circuit wp_get_document_title(),
	 * returning that value instead.
	 *
	 * @since 4.4.0
	 *
	 * @param string $title The document title. Default empty string.
	 */
	$title = apply_filters( 'pre_get_document_title', '' );
	if ( ! empty( $title ) ) {
		return $title;
	}

	global $page, $paged;

	$title = array(
		'title' => '',
	);

	// If it's a 404 page, use a "Page not found" title.
	if ( is_404() ) {
		$title['title'] = __( 'Page not found' );

		// If it's a search, use a dynamic search results title.
	} elseif ( is_search() ) {
		/* translators: %s: Search query. */
		$title['title'] = sprintf( __( 'Search Results for &#8220;%s&#8221;' ), get_search_query() );

		// If on the front page, use the site title.
	} elseif ( is_front_page() ) {
		$title['title'] = get_bloginfo( 'name', 'display' );

		// If on a post type archive, use the post type archive title.
	} elseif ( is_post_type_archive() ) {
		$title['title'] = post_type_archive_title( '', false );

		// If on a taxonomy archive, use the term title.
	} elseif ( is_tax() ) {
		$title['title'] = single_term_title( '', false );

		/*
		* If we're on the blog page that is not the homepage
		* or a single post of any post type, use the post title.
		*/
	} elseif ( is_home() || is_singular() ) {
		$title['title'] = single_post_title( '', false );

		// If on a category or tag archive, use the term title.
	} elseif ( is_category() || is_tag() ) {
		$title['title'] = single_term_title( '', false );

		// If on an author archive, use the author's display name.
	} elseif ( is_author() && get_queried_object() ) {
		$author         = get_queried_object();
		$title['title'] = $author->display_name;

		// If it's a date archive, use the date as the title.
	} elseif ( is_year() ) {
		$title['title'] = get_the_date( _x( 'Y', 'yearly archives date format' ) );

	} elseif ( is_month() ) {
		$title['title'] = get_the_date( _x( 'F Y', 'monthly archives date format' ) );

	} elseif ( is_day() ) {
		$title['title'] = get_the_date();
	}

	// Add a page number if necessary.
	if ( ( $paged >= 2 || $page >= 2 ) && ! is_404() ) {
		/* translators: %s: Page number. */
		$title['page'] = sprintf( __( 'Page %s' ), max( $paged, $page ) );
	}

	// Append the description or site title to give context.
	if ( is_front_page() ) {
		$title['tagline'] = get_bloginfo( 'description', 'display' );
	} else {
		$title['site'] = get_bloginfo( 'name', 'display' );
	}

	/**
	 * Filters the separator for the document title.
	 *
	 * @since 4.4.0
	 *
	 * @param string $sep Document title separator. Default '-'.
	 */
	$sep = apply_filters( 'document_title_separator', '-' );

	/**
	 * Filters the parts of the document title.
	 *
	 * @since 4.4.0
	 *
	 * @param array $title {
	 *     The document title parts.
	 *
	 *     @type string $title   Title of the viewed page.
	 *     @type string $page    Optional. Page number if paginated.
	 *     @type string $tagline Optional. Site description when on home page.
	 *     @type string $site    Optional. Site title when not on home page.
	 * }
	 */
	$title = apply_filters( 'document_title_parts', $title );

	$title = implode( " $sep ", array_filter( $title ) );

	/**
	 * Filters the document title.
	 *
	 * @since 5.8.0
	 *
	 * @param string $title Document title.
	 */
	$title = apply_filters( 'document_title', $title );

	return $title;
}