WordPress获取友情链接数据标签:get_bookmarks
2022/07/13
WordPress模板标签get_bookmarks用于获取友情链接数据,将返回所有友情链接的信息。
get_bookmarks( array|string $args = '' )
函数参数
$args
数组或字符串值
get_bookmarks()函数$args参数默认的值如下:
$args = array( 'orderby' => 'name', 'order' => 'ASC', 'limit' => -1, 'category' => '', 'category_name' => '', 'hide_invisible' => 1, 'show_updated' => 0, 'include' => '', 'exclude' => '', 'search' => '' );
get_bookmarks()函数$args参数可用的值如下:
orderby
字符串值,默认值:name
指定排序的方式,可用的值如下:
- link_id:按照友情链接的ID排序;
- url:按照链接排序;
- name:按照名称排序;
- owner:按照添加书签的用户排序;
- rating:按照评论排序;
- visible:按照可见度排序;
- length:按照长度排序;
- rand:随机顺序;
order
字符串值,默认值:ASC
升序或降序排列:
- ASC:升序排列;
- DESC:降序排列;
limit
整数型,默认值:-1
指定返回链接的数量,默认为返回所有链接。
category
字符串值,默认为空
以逗号分隔的友情链接分类ID,指定返回哪些分类的链接,默认返回所有分类的链接。
category_name
字符串值,默认为空
友情链接分类名称,指定返回哪个分类的链接。
hide_invisible
布尔值,默认值:true
是否隐藏私密链接,true表示隐藏。
show_updated
布尔值,默认值:false
如果为true,将额外返回link_category_f输出link_updated的值,但是以时间戳的形式。
include
字符串值,默认为空
以逗号分隔的友情链接ID,将返回这些ID的链接信息。
exclude
字符串值,默认为空
以逗号分隔的友情链接ID,返回结果中将排除这些ID的链接。
search
字符串值,默认为空
搜索link_url、link_name、link_description的值,返回符合搜索字符的结果。
函数返回值
Array ( [0] => stdClass Object ( [link_id] => 16 [link_url] => https://www.beizigen.com/ [link_name] => 背字根 [link_image] => [link_target] => _blank [link_description] => 开发运营笔记 [link_visible] => Y [link_owner] => 88891 [link_rating] => 0 [link_updated] => 0000-00-00 00:00:00 [link_rel] => [link_notes] => [link_rss] => ) )
函数使用示例
<?php $bookmarks = get_bookmarks( array( 'orderby' => 'name', 'order' => 'ASC', )); foreach ( $bookmarks as $bookmark ) { printf( '<li><a class="relatedlink" href="%s">%s</a></li>', $bookmark->link_url, $bookmark->link_name ); } ?>