post_type_archive_title() – Display or retrieve title for a post type archive.
You appear to be a bot. Output may be restricted
Description
Displays or retrieves 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.
Usage
$string|void = post_type_archive_title( $prefix, $display );
Parameters
- $prefix
- ( string ) optional – Optional. What to display before the title.
- $display
- ( bool ) optional default: 1 – Optional. Whether to display or retrieve title. Default true.
Returns
string|void Title when retrieving, null when displaying or failure.
Source
File name: wordpress/wp-includes/general-template.php
Lines:
1 to 28 of 28
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; } }