post_type_archive_title( string $prefix = '', bool $display = true )
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
- $prefix
-
(Optional) What to display before the title.
Default value: ''
- $display
-
(Optional) Whether to display or retrieve title.
Default value: true
Return
(string|void) Title when retrieving, null when displaying or failure.
Source
File: wp-includes/general-template.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 WP-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;
}
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |