post_type_archive_title( string $prefix = '', bool $display = true ): string|null

Description

Parameters

$prefixstringoptional

What to display before the title.Default: ''

$displaybooloptional

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

Return

string|null

Title when retrieving, null when displaying or on failure.

Hooks fired · 1

One hook fires while post_type_archive_title() runs, in this order:

1. 1
   apply_filters( post_type_archive_title )filterline 1754 (+20 into the body)

   Filters the post type archive title.

Uses · 4

• is_post_type_archive()Determines whether the query is for an existing post type archive page.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• get_post_type_object()Retrieves a post type object by name.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 4

• get_the_archive_title()Retrieves the archive title based on the queried object.
• twentynineteen_get_the_archive_title()Filters the default archive titles.
• wp_get_document_title()Returns document title for the current page.
• wp_title()Displays or retrieves page title for all areas of blog.

Source

View on Trac ↗View on GitHub ↗

1734function post_type_archive_title( $prefix = '', $display = true ) {1735	if ( ! is_post_type_archive() ) {1736		return null;1737	}1738 1739	$post_type = get_query_var( 'post_type' );1740	if ( is_array( $post_type ) ) {1741		$post_type = reset( $post_type );1742	}1743 1744	$post_type_obj = get_post_type_object( $post_type );1745 1746	/**1747	 * Filters the post type archive title.1748	 *1749	 * @since 3.1.01750	 *1751	 * @param string $post_type_name Post type 'name' label.1752	 * @param string $post_type      Post type.1753	 */1754	$title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type );1755 1756	if ( $display ) {1757		echo $prefix . $title;1758	} else {1759		return $prefix . $title;1760	}1761}

History

Introduced in 3.1.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 7.1.0 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.