wp_get_document_title(): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

string

Tag with the document title.

Performance profile

How much work a call to wp_get_document_title() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–110

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 194.

Plugin surface

4 hooks

Third-party callbacks on 'pre_get_document_title', 'document_title_separator', 'document_title_parts' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below wp_get_document_title()
• querycontent queryget_post()one call below wp_get_document_title()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 55 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_document_title() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 4

4 hooks fire while wp_get_document_title() runs, in this order:

1. 1
   apply_filters( pre_get_document_title )filterline 1188 (+12 into the body)

   Filters the document title before it is generated.

2. 2
   apply_filters( document_title_separator )filterline 1267 (+91 into the body)

   Filters the separator for the document title.

3. 3
   apply_filters( document_title_parts )filterline 1283 (+107 into the body)

   Filters the parts of the document title.

4. 4
   apply_filters( document_title )filterline 1294 (+118 into the body)

   Filters the document title.

Uses · 23

• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_404()Determines whether the query has resulted in a 404 (returns no results).
• __()Retrieves the translation of $text.
• is_search()Determines whether the query is for a search.
• get_search_query()Retrieves the contents of the search WordPress query variable.
• is_front_page()Determines whether the query is for the front page of the site.
• get_bloginfo()Retrieves information about the current site.
• is_post_type_archive()Determines whether the query is for an existing post type archive page.
• post_type_archive_title()Displays or retrieves title for a post type archive.
• is_tax()Determines whether the query is for an existing custom taxonomy archive page.
• single_term_title()Displays or retrieves page title for taxonomy term archive.
• is_home()Determines whether the query is for the blog homepage.

Used by · 3

• _block_template_render_title_tag()Displays title tag with content, regardless of whether theme has title-tag support.
• _wp_render_title_tag()Displays title tag with content.
• get_wp_title_rss()Retrieves the blog title for the feed title.

Source code

View on Trac ↗View on GitHub ↗

1176function wp_get_document_title() {1177 1178	/**1179	 * Filters the document title before it is generated.1180	 *1181	 * Passing a non-empty value will short-circuit wp_get_document_title(),1182	 * returning that value instead.1183	 *1184	 * @since 4.4.01185	 *1186	 * @param string $title The document title. Default empty string.1187	 */1188	$title = apply_filters( 'pre_get_document_title', '' );1189	if ( ! empty( $title ) ) {1190		return $title;1191	}1192 1193	global $page, $paged;1194 1195	$title = array(1196		'title' => '',1197	);1198 1199	// If it's a 404 page, use a "Page not found" title.1200	if ( is_404() ) {1201		$title['title'] = __( 'Page not found' );1202 1203		// If it's a search, use a dynamic search results title.1204	} elseif ( is_search() ) {1205		/* translators: %s: Search query. */1206		$title['title'] = sprintf( __( 'Search Results for “%s”' ), get_search_query() );1207 1208		// If on the front page, use the site title.1209	} elseif ( is_front_page() ) {1210		$title['title'] = get_bloginfo( 'name', 'display' );1211 1212		// If on a post type archive, use the post type archive title.1213	} elseif ( is_post_type_archive() ) {1214		$title['title'] = post_type_archive_title( '', false );1215 1216		// If on a taxonomy archive, use the term title.1217	} elseif ( is_tax() ) {1218		$title['title'] = single_term_title( '', false );1219 1220		/*1221		* If we're on the blog page that is not the homepage1222		* or a single post of any post type, use the post title.1223		*/1224	} elseif ( is_home() || is_singular() ) {1225		$title['title'] = single_post_title( '', false );1226 1227		// If on a category or tag archive, use the term title.1228	} elseif ( is_category() || is_tag() ) {1229		$title['title'] = single_term_title( '', false );1230 1231		// If on an author archive, use the author's display name.1232	} elseif ( is_author() && get_queried_object() ) {1233		$author         = get_queried_object();1234		$title['title'] = $author->display_name;1235 1236		// If it's a date archive, use the date as the title.1237	} elseif ( is_year() ) {1238		$title['title'] = get_the_date( _x( 'Y', 'yearly archives date format' ) );1239 1240	} elseif ( is_month() ) {1241		$title['title'] = get_the_date( _x( 'F Y', 'monthly archives date format' ) );1242 1243	} elseif ( is_day() ) {1244		$title['title'] = get_the_date();1245	}1246 1247	// Add a page number if necessary.1248	if ( ( $paged >= 2 || $page >= 2 ) && ! is_404() ) {1249		/* translators: %s: Page number. */1250		$title['page'] = sprintf( __( 'Page %s' ), max( $paged, $page ) );1251	}1252 1253	// Append the description or site title to give context.1254	if ( is_front_page() ) {1255		$title['tagline'] = get_bloginfo( 'description', 'display' );

Changelog

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/general-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.