post_type_archive_title() – Function | Developer.WordPress.org

Displays or retrieves title for a post type archive.

Description

This is optimized for archive.php and archive-{$post_type}.php template files for displaying the title of the post type.

Parameters

$prefixstringoptional: What to display before the title.
Default:''
$displaybooloptional: Whether to display or retrieve title.
Default:true

Return

string|void Title when retrieving, null when displaying or failure.

Source

function post_type_archive_title( $prefix = '', $display = true ) {
	if ( ! is_post_type_archive() ) {
		return;
	}

	$post_type = get_query_var( 'post_type' );
	if ( is_array( $post_type ) ) {
		$post_type = reset( $post_type );
	}

	$post_type_obj = get_post_type_object( $post_type );

	/**
	 * Filters the post type archive title.
	 *
	 * @since 3.1.0
	 *
	 * @param string $post_type_name Post type 'name' label.
	 * @param string $post_type      Post type.
	 */
	$title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type );

	if ( $display ) {
		echo $prefix . $title;
	} else {
		return $prefix . $title;
	}
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘post_type_archive_title’, string $post_type_name, string $post_type ): Filters the post type archive title.

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

Show 2 more Show less

Used by	Description
wp_get_document_title()`wp-includes/general-template.php`	Returns document title for the current page.
get_the_archive_title()`wp-includes/general-template.php`	Retrieves the archive title based on the queried object.
wp_title()`wp-includes/general-template.php`	Displays or retrieves page title for all areas of blog.

Changelog

Version	Description
3.1.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Display the Custom Post Type title:
```
<h1><?php post_type_archive_title(); ?></h1>
```
Log in to add feedback

post_type_archive_title( string $prefix = ”, bool $display = true ): string|void

In this article