get_archives_link

函数
get_archives_link ( $url, $text, $format = 'html', $before = '', $after = '', $selected = false )
参数
  • (string) $url URL to archive.
    Required:
  • (string) $text Archive text description.
    Required:
  • (string) $format Optional. Can be 'link', 'option', 'html', or custom. Default 'html'.
    Required:
    Default: 'html'
  • (string) $before Optional. Content to prepend to the description. Default empty.
    Required:
    Default: (empty)
  • (string) $after Optional. Content to append to the description. Default empty.
    Required:
    Default: (empty)
  • (bool) $selected Optional. Set to true if the current page is the selected archive page.
    Required:
    Default: false
返回值
  • (string) HTML link content for archive.
定义位置
相关方法
get_archivesget_search_linkget_search_feed_linkwp_get_archivesget_post_type_archive_link
引入
1.0.0
弃用
-

get_archives_link: 这个函数根据所提供的参数,返回到一个档案页的超链接: 该函数返回一个包含档案链接的字符串。

根据预定义或自定义代码检索档案链接内容。

格式可以是四种风格中的一种。用于头部元素的’link’,用于选择元素的’option’,用于列表(ol或ul HTML元素)的’html’。也支持使用前后参数的自定义内容。

链接’格式使用“HTML元素与**档案**关系。之前和之后的参数不被使用。文本参数用于描述该链接。

选项”格式使用选项HTML元素,用于选择元素。其值是url参数,前后参数用于文本描述之间。

html’格式,这是默认的,使用li HTML元素,用于列表HTML元素中。before参数是在链接之前,after参数是在关闭链接之后。

自定义格式在链接(’a’HTML元素)之前使用前参数,在关闭链接标签之后使用后参数。如果没有使用上述三个格式的值,则假定为自定义格式。

function get_archives_link( $url, $text, $format = 'html', $before = '', $after = '', $selected = false ) {
	$text         = wptexturize( $text );
	$url          = esc_url( $url );
	$aria_current = $selected ? ' aria-current="page"' : '';

	if ( 'link' === $format ) {
		$link_html = "t<link rel='archives' title='" . esc_attr( $text ) . "' href='$url' />n";
	} elseif ( 'option' === $format ) {
		$selected_attr = $selected ? " selected='selected'" : '';
		$link_html     = "t<option value='$url'$selected_attr>$before $text $after</option>n";
	} elseif ( 'html' === $format ) {
		$link_html = "t<li>$before<a href='$url'$aria_current>$text</a>$after</li>n";
	} else { // Custom.
		$link_html = "t$before<a href='$url'$aria_current>$text</a>$aftern";
	}

	/**
	 * Filters the archive link content.
	 *
	 * @since 2.6.0
	 * @since 4.5.0 Added the `$url`, `$text`, `$format`, `$before`, and `$after` parameters.
	 * @since 5.2.0 Added the `$selected` parameter.
	 *
	 * @param string $link_html The archive HTML link content.
	 * @param string $url       URL to archive.
	 * @param string $text      Archive text description.
	 * @param string $format    Link format. Can be 'link', 'option', 'html', or custom.
	 * @param string $before    Content to prepend to the description.
	 * @param string $after     Content to append to the description.
	 * @param bool   $selected  True if the current page is the selected archive.
	 */
	return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after, $selected );
}

常见问题

FAQs
查看更多 >