get_month_link() – Function | Developer.WordPress.org

Retrieves the permalink for the month archives with year.

Parameters

$yearint|falserequired: Integer of year. False for current year.
$monthint|falserequired: Integer of month. False for current month.

Return

string The permalink for the specified month and year archive.

More Information

In a Plugin or Theme, it can be used as early as the setup_theme Action. Any earlier usage, including plugins_loaded, generates a Fatal Error.

Source

function get_month_link( $year, $month ) {
	global $wp_rewrite;
	if ( ! $year ) {
		$year = current_time( 'Y' );
	}
	if ( ! $month ) {
		$month = current_time( 'm' );
	}
	$monthlink = $wp_rewrite->get_month_permastruct();
	if ( ! empty( $monthlink ) ) {
		$monthlink = str_replace( '%year%', $year, $monthlink );
		$monthlink = str_replace( '%monthnum%', zeroise( (int) $month, 2 ), $monthlink );
		$monthlink = home_url( user_trailingslashit( $monthlink, 'month' ) );
	} else {
		$monthlink = home_url( '?m=' . $year . zeroise( $month, 2 ) );
	}

	/**
	 * Filters the month archive permalink.
	 *
	 * @since 1.5.0
	 *
	 * @param string $monthlink Permalink for the month archive.
	 * @param int    $year      Year for the archive.
	 * @param int    $month     The month for the archive.
	 */
	return apply_filters( 'month_link', $monthlink, $year, $month );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘month_link’, string $monthlink, int $year, int $month ): Filters the month archive permalink.

Uses	Description
zeroise()`wp-includes/formatting.php`	Add leading zeros when necessary.
current_time()`wp-includes/functions.php`	Retrieves the current time based on specified type.
user_trailingslashit()`wp-includes/link-template.php`	Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
WP_Rewrite::get_month_permastruct()`wp-includes/class-wp-rewrite.php`	Retrieves the month permalink structure without day and with year.
home_url()`wp-includes/link-template.php`	Retrieves the URL for the current site where the front end is accessible.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 2 more Show less

Used by	Description
wp_get_archives()`wp-includes/general-template.php`	Displays archive links based on type and format.
get_calendar()`wp-includes/general-template.php`	Displays calendar with days that have posts as links.
redirect_canonical()`wp-includes/canonical.php`	Redirects incoming links to the proper URL based on the site url.

Changelog

Version	Description
1.0.0	Introduced.

User Contributed Notes

Skip to note 4 content

Codex 9 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 Archive as Link

Returns the URL to the current month’s archive as a link by displaying it within an anchor tag with the PHP echo command.
```
<a href="<?php echo get_month_link('', ''); ?>">All posts this month</a>
```
Log in to add feedback
Skip to note 5 content

Codex 9 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
Assigning Specific Month to Variable

Returns URL to the archive for October 2004, assigning it to the variable $oct_04. The variable can then be used elsewhere in a page.
```
<?php $oct_04 = get_month_link('2004', '10'); ?>
```
Log in to add feedback
Skip to note 6 content

Codex 9 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
Use With PHP Variables

PHP code block for use within The Loop: Assigns year and month of a post to the variables $arc_year and $arc_month. These are used with the get_month_link() tag, which returns the URL as a link to the monthly archive for that post, displaying it within an anchor tag with the PHP echo command. See Formatting Date and Time for info on format strings used in get_the_time() tag.
```
<?php $archive_year  = get_the_time('Y'); ?>
<?php $archive_month = get_the_time('m'); ?>

<a href="<?php echo get_month_link( $archive_year, $archive_month ); ?>">
Archive for <?php the_time('F Y'); ?>
</a>
```
Log in to add feedback

get_month_link( int|false $year, int|false $month ): string

In this article