On this page
single_post_title( string $prefix = '', bool $display = true ): string|void
Displays or retrieves page title for post.
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
$prefixstring Optional-
What to display before the title.
Default:
'' $displaybool Optional-
Whether to display or retrieve title.
Default:
true
Return
string|void Title when retrieving.
Source
File: wp-includes/general-template.php. View all references
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 WP_Post $_post The current post.
*/
$title = apply_filters( 'single_post_title', $_post->post_title, $_post );
if ( $display ) {
echo $prefix . $title;
} else {
return $prefix . $title;
}
}
Hooks
- apply_filters( 'single_post_title',
string $_post_title ,WP_Post $_post ) -
Filters the page title for a single post.
Related
Uses
| Uses | Description |
|---|---|
| get_queried_object() wp-includes/query.php | Retrieves the currently queried object. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
Used By
| Used By | Description |
|---|---|
| wp_get_document_title() wp-includes/general-template.php | Returns document title for the current page. |
| wp_title() wp-includes/general-template.php | Displays or retrieves page title for all areas of blog. |
Changelog
| Version | Description |
|---|---|
| 0.71 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/single_post_title