single_post_title() WordPress Function

The single_post_title() function is used to display the title of a single post. This function can be used within the loop.

single_post_title( string $prefix = '', bool $display = true ) #

Display or retrieve 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.


Top ↑

Parameters

$prefix

(string)(Optional) What to display before the title.

Default value: ''

$display

(bool)(Optional) Whether to display or retrieve title.

Default value: true


Top ↑

Return

(string|void) Title when retrieving.


Top ↑

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


Top ↑

Changelog

Changelog
VersionDescription
0.71Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More