single_month_title() – Function | Developer.WordPress.org

Displays or retrieves page title for post archive based on date.

Description

Useful for when the template only needs to display the month and year, if either are available. 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

$prefixstringoptional: What to display before the title.
Default:''
$displaybooloptional: Whether to display or retrieve title.
Default:true

Return

string|false|void False if there’s no valid title for the month. Title when retrieving.

More Information

This tag only works when the m or archive month argument has been passed by WordPress to the current page (this occurs when viewing a monthly archive page).
This tag works only on date archive pages, not on category templates or others.
It does not support placing the separator after the title, but by leaving the prefix parameter empty, you can set the title separator manually.

Source

function single_month_title( $prefix = '', $display = true ) {
	global $wp_locale;

	$m        = get_query_var( 'm' );
	$year     = get_query_var( 'year' );
	$monthnum = get_query_var( 'monthnum' );

	if ( ! empty( $monthnum ) && ! empty( $year ) ) {
		$my_year  = $year;
		$my_month = $wp_locale->get_month( $monthnum );
	} elseif ( ! empty( $m ) ) {
		$my_year  = substr( $m, 0, 4 );
		$my_month = $wp_locale->get_month( substr( $m, 4, 2 ) );
	}

	if ( empty( $my_month ) ) {
		return false;
	}

	$result = $prefix . $my_month . $prefix . $my_year;

	if ( ! $display ) {
		return $result;
	}
	echo $result;
}

View all references View on Trac View on GitHub

Uses	Description
get_query_var()`wp-includes/query.php`	Retrieves the value of a query variable in the WP_Query class.
WP_Locale::get_month()`wp-includes/class-wp-locale.php`	Retrieves the full translated month by month number.

Changelog

Version	Description
0.71	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Month and Year on New Lines

Displays the title, placing month and year on new lines.
```
<p><?php single_month_title('<br />') ?></p>
```
Output is following 2 lines.
```
December
2004
```
Log in to add feedback

single_month_title( string $prefix = '', bool $display = true ): string|false|void

In this article