Summery Summery
Display or retrieve page title for taxonomy term archive.
Syntax Syntax
Description Description
Useful for taxonomy term template files for displaying the taxonomy term page title. The prefix does not automatically place a space between the prefix, so if there should be a space, the parameter value will need to have it at the end.
Parameters Parameters
- $prefix
-
(Optional) What to display before the title.
Default value: ''
- $display
-
(Optional) Whether to display or retrieve title.
Default value: true
Return Return
(string|void) Title when retrieving.
Source Source
File: wp-includes/general-template.php
echo $prefix . $title; } else { return $prefix . $title; } } /** * 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. * * @since 3.1.0 * * @param string $prefix Optional. What to display before the title. * @param bool $display Optional. Whether to display or retrieve title. Default true. * @return string|void Title when retrieving, null when displaying or failure. */ 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; } } /**
Advertisement
Changelog Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |