wpseek.com
A WordPress-centric search engine for devs and theme authors



post_type_archive_title › WordPress Function

Since3.1.0
Deprecatedn/a
› post_type_archive_title ( $prefix = '', $display = true )
Parameters: (2)
  • (string) $prefix Optional. What to display before the title.
    Required: No
    Default: (empty)
  • (bool) $display Optional. Whether to display or retrieve title. Default true.
    Required: No
    Default: true
Returns:
  • (string|void) Title when retrieving, null when displaying or failure.
Defined at:
Codex:

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.


Related Functions: get_the_archive_title, the_archive_title, is_post_type_archive, get_post_type_archive_link, get_post_type_archive_template

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