single_post_title( string $prefix = '', bool $display = true )
Display or retrieve page title for post.
Description Description
This is optimized for single.php template file for displaying the post title.
It does not support placing the separator after the title, but by leaving the prefix parameter empty, you can set the title separator manually. 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
-
(string) (Optional) What to display before the title.
Default value: ''
- $display
-
(bool) (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
function single_post_title( $prefix = '', $display = true ) {
$_post = get_queried_object();
if ( ! isset( $_post->post_title ) ) {
return;
}
/**
* Filters the page title for a single post.
*
* @since 0.71
*
* @param string $_post_title The single post page title.
* @param object $_post The current queried object as returned by get_queried_object().
*/
$title = apply_filters( 'single_post_title', $_post->post_title, $_post );
if ( $display ) {
echo $prefix . $title;
} else {
return $prefix . $title;
}
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 0.71 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example
Result:
Current post: Single Post Title