wp_get_document_title()

Опубликовано автором

wp_get_document_title();

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

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

После заголовка страницы сайта добавляется название сайта через разделитель ‘ — ‘. На главной странице is_home() && is_front_page() вместо названия выводится описание сайта.

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

add_theme_support( ‘title-tag’ );

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

При автоматическом добавлении тега <title> WordPress будет использовать эту функцию для вывода заголовка, т.е. будет добавлена такая конструкция:

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

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

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

Используйте фильтр document_title_parts, чтобы изменить части заголовка выводимого этой функцией.

Примеры

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return $title;
}

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

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

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

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

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

add_filter('document_title_parts', function( $parts ){
	if( isset($parts['site']) ) unset($parts['site']);
	return $parts;
});

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

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

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

	return $title;
});

Код wp get document title: wp-includes/general-template.php WP 5.2.4

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 phrase */
		$title['title'] = sprintf( __( 'Search Results for “%s”' ), 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() && $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() ) {
		$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 ) );
	$title = wptexturize( $title );
	$title = convert_chars( $title );
	$title = esc_html( $title );
	$title = capital_P_dangit( $title );

	return $title;
}

источник: https://wp-kama.ru/function/wp_get_document_title