云策 WordPress 开发者社区

函数文档

get_year_link()

查看官方原文 ↗
💡 云策文档标注

概述

get_year_link() 函数用于获取指定年份归档页面的固定链接。它支持自定义年份参数，并处理不同重写规则下的链接生成。

关键要点

  • 函数接受一个整数参数 $year，表示年份；若为 false 则使用当前年份。
  • 返回值为字符串类型的归档页面永久链接。
  • 内部逻辑基于 WP_Rewrite 类：优先使用重写结构生成链接，否则回退到查询字符串格式。
  • 通过 apply_filters('year_link', $yearlink, $year) 钩子允许过滤链接输出。
  • 相关函数包括 current_time()、user_trailingslashit()、WP_Rewrite::get_year_permastruct() 和 home_url()。

代码示例

// 获取当前年份归档链接
$current_year_link = get_year_link( false );

// 获取指定年份（如2003）归档链接
$year2003_link = get_year_link( 2003 );

// 在模板中输出链接
echo '<a href="' . esc_url( get_year_link( 2003 ) ) . '">Posts from 2003</a>';

注意事项

  • 确保重写规则已正确设置，否则链接可能回退到查询字符串格式（如 ?m=2023）。
  • 使用 apply_filters('year_link') 可自定义链接生成逻辑。
  • 函数自 WordPress 1.5.0 版本引入，兼容性良好。
📄 原文内容

Retrieves the permalink for the year archives.

Parameters

$yearint|falserequired
Integer of year. False for current year.

Return

string The permalink for the specified year archive.

Source

function get_year_link( $year ) {
	global $wp_rewrite;
	if ( ! $year ) {
		$year = current_time( 'Y' );
	}
	$yearlink = $wp_rewrite->get_year_permastruct();
	if ( ! empty( $yearlink ) ) {
		$yearlink = str_replace( '%year%', $year, $yearlink );
		$yearlink = home_url( user_trailingslashit( $yearlink, 'year' ) );
	} else {
		$yearlink = home_url( '?m=' . $year );
	}

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

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘year_link’, string $yearlink, int $year )

Filters the year archive permalink.

Uses Description
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_year_permastruct()wp-includes/class-wp-rewrite.php

Retrieves the year permalink structure without month and day.
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 moreShow less

Used by Description
wp_get_archives()wp-includes/general-template.php

Displays archive links based on type and format.
redirect_canonical()wp-includes/canonical.php

Redirects incoming links to the proper URL based on the site url.

Changelog

Version Description
1.5.0 Introduced.

User Contributed Notes

  3. Skip to note 6 content


    Codex


    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

    Using With PHP Variables

    PHP code block for use within The Loop: Assigns year to the variable $arc_year. This is used with the get_year_link() tag, which returns the URL as a link to the yearly archive for a 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.

    

<a href="<?php echo get_year_link( $archive_year ); ?>"> archive</a>