描述
格式可以是四种样式之一。head元素的“link”,在select元素中使用的“option”,在列表中使用的“html”(ol或ul html元素)。使用before和after参数也支持自定义内容。
“link”格式使用具有存档关系的<link>
HTML元素。不使用前后参数。text参数用于描述链接。
“option”格式使用option HTML元素用于select元素。该值是url参数,在文本描述之间使用前后参数。
“html”格式是默认格式,在列表html元素中使用li html元素。before参数位于链接之前,after参数位于关闭链接之后。
自定义格式在链接(“a”HTML元素)之前使用before参数,在结束链接标记之后使用after参数。如果不使用格式的上述三个值,则假设为自定义格式。
参数
- $url
-
(string) (必填) 存档的URL
- $text
-
(string) (必填) 存档文本描述
- $format
-
(string) (可选) 可以是“link”、“option”、“html”或自定义。
默认值: 'html'
- $before
-
(string) (可选) 前置添加到描述的内容。
默认值: ''
- $after
-
(string) (可选) 要附加到描述的内容。
默认值: ''
- $selected
-
(bool) (可选) 如果当前页面是选定的存档页面,则设置为true。
默认值: false
返回
(string) 存档的HTML链接内容。
源码
更新日志
版本 | 描述 |
---|---|
5.2.0 | 添加了$selected 参数 |
1.0.0 | 开始引入 |
使用示例
在核心存档小工具中的post计数周围添加一个span。这样可以轻松设置计数的样式。
/** * Adds a span around post counts in the archive widget. * * @param string $links The comment fields. * @return string */ function wpdocs_archive_count_span( $links ) { $links = str_replace( '</a> (', '<span class="count">', $links ); $links = str_replace( ')', '</span></a>', $links ); return $links; } add_filter( 'get_archives_link', 'wpdocs_archive_count_span' );