WordPress at a glance

post_type_archive_title() WP 1.0

Display or retrieve title for a post type archive.

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

Is the basis for: wp_get_document_title()
Hooks in function
Return

String/null. Title when retrieving, null when displaying or failure.

Usage

post_type_archive_title( $prefix, $display );
$prefix(string)
What to display before the title.
Default: ''
$display(true/false)
Whether to display or retrieve title.
Default: true

Code of post type archive title: wp-includes/general-template.php WP 5.2.1

<?php
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;
	}
}

Related Functions

From tag: Archives (of posts)

More from category: Custom Types

More from Template Tags: Main Functions

No comments
    Hello, !     Log In . Register