wp_title( string $sep = '»', bool $display = true, string $seplocation = '' ): string|void

Description

Compatibility

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

Parameters

$sepstringoptional

How to separate the various items within the page title.
Default '»'.Default: '»'

$displaybooloptional

Whether to display or retrieve title. Default true.Default: true

$seplocationstringoptional

Location of the separator (either 'left' or 'right').Default: ''

Return value

string|void

String when $display is false, nothing otherwise.

Performance profile

How much work a call to wp_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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

93–164

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

Plugin surface

2 hooks

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, 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 · 128 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 2

2 hooks fire while wp_title() runs, in this order:

1. 1
   apply_filters( wp_title_parts )filterline 1445 (+106 into the body)

   Filters the parts of the page title.

2. 2
   apply_filters( wp_title )filterline 1464 (+125 into the body)

   Filters the text of the page title.

Uses · 22

• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• is_single()Determines whether the query is for an existing single post.
• is_home()Determines whether the query is for the blog homepage.
• is_front_page()Determines whether the query is for the front page of the site.
• is_page()Determines whether the query is for an existing single page.
• single_post_title()Displays or retrieves page title for post.
• is_post_type_archive()Determines whether the query is for an existing post type archive page.
• get_post_type_object()Retrieves a post type object by name.
• post_type_archive_title()Displays or retrieves title for a post type archive.
• is_category()Determines whether the query is for an existing category archive page.
• is_tag()Determines whether the query is for an existing tag archive page.
• single_term_title()Displays or retrieves page title for taxonomy term archive.

Source code

View on Trac ↗View on GitHub ↗

1339function wp_title( $sep = '»', $display = true, $seplocation = '' ) {1340	global $wp_locale;1341 1342	$m        = get_query_var( 'm' );1343	$year     = get_query_var( 'year' );1344	$monthnum = get_query_var( 'monthnum' );1345	$day      = get_query_var( 'day' );1346	$search   = get_query_var( 's' );1347	$title    = '';1348 1349	$t_sep = '%WP_TITLE_SEP%'; // Temporary separator, for accurate flipping, if necessary.1350 1351	// If there is a post.1352	if ( is_single() || ( is_home() && ! is_front_page() ) || ( is_page() && ! is_front_page() ) ) {1353		$title = single_post_title( '', false );1354	}1355 1356	// If there's a post type archive.1357	if ( is_post_type_archive() ) {1358		$post_type = get_query_var( 'post_type' );1359		if ( is_array( $post_type ) ) {1360			$post_type = reset( $post_type );1361		}1362		$post_type_object = get_post_type_object( $post_type );1363		if ( ! $post_type_object->has_archive ) {1364			$title = post_type_archive_title( '', false );1365		}1366	}1367 1368	// If there's a category or tag.1369	if ( is_category() || is_tag() ) {1370		$title = single_term_title( '', false );1371	}1372 1373	// If there's a taxonomy.1374	if ( is_tax() ) {1375		$term = get_queried_object();1376		if ( $term ) {1377			$tax   = get_taxonomy( $term->taxonomy );1378			$title = single_term_title( $tax->labels->name . $t_sep, false );1379		}1380	}1381 1382	// If there's an author.1383	if ( is_author() && ! is_post_type_archive() ) {1384		$author = get_queried_object();1385		if ( $author ) {1386			$title = $author->display_name;1387		}1388	}1389 1390	// Post type archives with has_archive should override terms.1391	if ( is_post_type_archive() && $post_type_object->has_archive ) {1392		$title = post_type_archive_title( '', false );1393	}1394 1395	// If there's a month.1396	if ( is_archive() && ! empty( $m ) ) {1397		$my_year  = substr( $m, 0, 4 );1398		$my_month = substr( $m, 4, 2 );1399		$my_day   = (int) substr( $m, 6, 2 );1400		$title    = $my_year .1401			( $my_month ? $t_sep . $wp_locale->get_month( $my_month ) : '' ) .1402			( $my_day ? $t_sep . $my_day : '' );1403	}1404 1405	// If there's a year.1406	if ( is_archive() && ! empty( $year ) ) {1407		$title = $year;1408		if ( ! empty( $monthnum ) ) {1409			$title .= $t_sep . $wp_locale->get_month( $monthnum );1410		}1411		if ( ! empty( $day ) ) {1412			$title .= $t_sep . zeroise( $day, 2 );1413		}1414	}1415 1416	// If it's a search.1417	if ( is_search() ) {1418		/* translators: 1: Separator, 2: Search query. */

Changelog

Introduced in 1.0.0. One change between 6.7.7 and 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.9.7 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.