get_month_link() WordPress Function
The get_month_link() function in WordPress is used to get the permalink for a month archive. This function takes two parameters: the year and the month. The year must be four digits, and the month must be two digits.
get_month_link( int|false $year, int|false $month ) #
Retrieves the permalink for the month archives with year.
Parameters
- $year
(int|false)(Required)Integer of year. False for current year.
- $month
(int|false)(Required)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
File: wp-includes/link-template.php
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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 1.0.0 | Introduced. |