`.
* @type string $after The HTML or text to append to each bookmark. Default ``.
* @type string $link_before The HTML or text to prepend to each bookmark inside the anchor
* tags. Default empty.
* @type string $link_after The HTML or text to append to each bookmark inside the anchor
* tags. Default empty.
* @type string $between The string for use in between the link, description, and image.
* Default "\n".
* @type int|bool $show_rating Whether to show the link rating. Accepts 1|true or 0|false.
* Default 0|false.
*
* }
* @return string Formatted output in HTML
*/
function _walk_bookmarks( $bookmarks, $args = '' ) {
$defaults = array(
'show_updated' => 0, 'show_description' => 0,
'show_images' => 1, 'show_name' => 0,
'before' => '', 'after' => '', 'between' => "\n",
'show_rating' => 0, 'link_before' => '', 'link_after' => ''
);
$r = wp_parse_args( $args, $defaults );
$output = ''; // Blank string to start with.
foreach ( (array) $bookmarks as $bookmark ) {
if ( ! isset( $bookmark->recently_updated ) ) {
$bookmark->recently_updated = false;
}
$output .= $r['before'];
if ( $r['show_updated'] && $bookmark->recently_updated ) {
$output .= '';
}
$the_link = '#';
if ( ! empty( $bookmark->link_url ) ) {
$the_link = esc_url( $bookmark->link_url );
}
$desc = esc_attr( sanitize_bookmark_field( 'link_description', $bookmark->link_description, $bookmark->link_id, 'display' ) );
$name = esc_attr( sanitize_bookmark_field( 'link_name', $bookmark->link_name, $bookmark->link_id, 'display' ) );
$title = $desc;
if ( $r['show_updated'] ) {
if ( '00' != substr( $bookmark->link_updated_f, 0, 2 ) ) {
$title .= ' (';
$title .= sprintf(
__('Last updated: %s'),
date(
get_option( 'links_updated_date_format' ),
$bookmark->link_updated_f + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS )
)
);
$title .= ')';
}
}
$alt = ' alt="' . $name . ( $r['show_description'] ? ' ' . $title : '' ) . '"';
if ( '' != $title ) {
$title = ' title="' . $title . '"';
}
$rel = $bookmark->link_rel;
if ( '' != $rel ) {
$rel = ' rel="' . esc_attr($rel) . '"';
}
$target = $bookmark->link_target;
if ( '' != $target ) {
$target = ' target="' . $target . '"';
}
$output .= '';
$output .= $r['link_before'];
if ( $bookmark->link_image != null && $r['show_images'] ) {
if ( strpos( $bookmark->link_image, 'http' ) === 0 ) {
$output .= "![](\"$bookmark-)
link_image\" $alt $title />";
} else { // If it's a relative path
$output .= "![](\"")
link_image\" $alt $title />";
}
if ( $r['show_name'] ) {
$output .= " $name";
}
} else {
$output .= $name;
}
$output .= $r['link_after'];
$output .= '';
if ( $r['show_updated'] && $bookmark->recently_updated ) {
$output .= '';
}
if ( $r['show_description'] && '' != $desc ) {
$output .= $r['between'] . $desc;
}
if ( $r['show_rating'] ) {
$output .= $r['between'] . sanitize_bookmark_field(
'link_rating',
$bookmark->link_rating,
$bookmark->link_id,
'display'
);
}
$output .= $r['after'] . "\n";
} // end while
return $output;
}
/**
* Retrieve or echo all of the bookmarks.
*
* List of default arguments are as follows:
*
* These options define how the Category name will appear before the category
* links are displayed, if 'categorize' is 1. If 'categorize' is 0, then it will
* display for only the 'title_li' string and only if 'title_li' is not empty.
*
* @since 2.1.0
*
* @see _walk_bookmarks()
*
* @param string|array $args {
* Optional. String or array of arguments to list bookmarks.
*
* @type string $orderby How to order the links by. Accepts post fields. Default 'name'.
* @type string $order Whether to order bookmarks in ascending or descending order.
* Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.
* @type int $limit Amount of bookmarks to display. Accepts 1+ or -1 for all.
* Default -1.
* @type string $category Comma-separated list of category ids to include links from.
* Default empty.
* @type string $category_name Category to retrieve links for by name. Default empty.
* @type int|bool $hide_invisible Whether to show or hide links marked as 'invisible'. Accepts
* 1|true or 0|false. Default 1|true.
* @type int|bool $show_updated Whether to display the time the bookmark was last updated.
* Accepts 1|true or 0|false. Default 0|false.
* @type int|bool $echo Whether to echo or return the formatted bookmarks. Accepts
* 1|true (echo) or 0|false (return). Default 1|true.
* @type int|bool $categorize Whether to show links listed by category or in a single column.
* Accepts 1|true (by category) or 0|false (one column). Default 1|true.
* @type int|bool $show_description Whether to show the bookmark descriptions. Accepts 1|true or 0|false.
* Default 0|false.
* @type string $title_li What to show before the links appear. Default 'Bookmarks'.
* @type string $title_before The HTML or text to prepend to the $title_li string. Default ''.
* @type string $title_after The HTML or text to append to the $title_li string. Default '
'.
* @type string $class The CSS class to use for the $title_li. Default 'linkcat'.
* @type string $category_before The HTML or text to prepend to $title_before if $categorize is true.
* String must contain '%id' and '%class' to inherit the category ID and
* the $class argument used for formatting in themes.
* Default ''.
* @type string $category_after The HTML or text to append to $title_after if $categorize is true.
* Default ''.
* @type string $category_orderby How to order the bookmark category based on term scheme if $categorize
* is true. Default 'name'.
* @type string $category_order Whether to order categories in ascending or descending order if
* $categorize is true. Accepts 'ASC' (ascending) or 'DESC' (descending).
* Default 'ASC'.
* }
* @return string|null Will only return if echo option is set to not echo. Default is not return anything.
*/
function wp_list_bookmarks( $args = '' ) {
$defaults = array(
'orderby' => 'name', 'order' => 'ASC',
'limit' => -1, 'category' => '', 'exclude_category' => '',
'category_name' => '', 'hide_invisible' => 1,
'show_updated' => 0, 'echo' => 1,
'categorize' => 1, 'title_li' => __('Bookmarks'),
'title_before' => '', 'title_after' => '
',
'category_orderby' => 'name', 'category_order' => 'ASC',
'class' => 'linkcat', 'category_before' => '',
'category_after' => ''
);
$r = wp_parse_args( $args, $defaults );
$output = '';
if ( $r['categorize'] ) {
$cats = get_terms( 'link_category', array(
'name__like' => $r['category_name'],
'include' => $r['category'],
'exclude' => $r['exclude_category'],
'orderby' => $r['category_orderby'],
'order' => $r['category_order'],
'hierarchical' => 0
) );
if ( empty( $cats ) ) {
$r['categorize'] = false;
}
}
if ( $r['categorize'] ) {
// Split the bookmarks into ul's for each category
foreach ( (array) $cats as $cat ) {
$params = array_merge( $r, array( 'category' => $cat->term_id ) );
$bookmarks = get_bookmarks( $params );
if ( empty( $bookmarks ) ) {
continue;
}
$output .= str_replace(
array( '%id', '%class' ),
array( "linkcat-$cat->term_id", $r['class'] ),
$r['category_before']
);
/**
* Filter the bookmarks category name.
*
* @since 2.2.0
*
* @param string $cat_name The category name of bookmarks.
*/
$catname = apply_filters( 'link_category', $cat->name );
$output .= $r['title_before'];
$output .= $catname;
$output .= $r['title_after'];
$output .= "\n\t\n";
$output .= _walk_bookmarks( $bookmarks, $r );
$output .= "\n\t
\n";
$output .= $r['category_after'] . "\n";
}
} else {
//output one single list using title_li for the title
$bookmarks = get_bookmarks( $r );
if ( ! empty( $bookmarks ) ) {
if ( ! empty( $r['title_li'] ) ) {
$output .= str_replace(
array( '%id', '%class' ),
array( "linkcat-" . $r['category'], $r['class'] ),
$r['category_before']
);
$output .= $r['title_before'];
$output .= $r['title_li'];
$output .= $r['title_after'];
$output .= "\n\t\n";
$output .= _walk_bookmarks( $bookmarks, $r );
$output .= "\n\t
\n";
$output .= $r['category_after'] . "\n";
} else {
$output .= _walk_bookmarks( $bookmarks, $r );
}
}
}
/**
* Filter the bookmarks list before it is echoed or returned.
*
* @since 2.5.0
*
* @param string $html The HTML list of bookmarks.
*/
$html = apply_filters( 'wp_list_bookmarks', $output );
if ( ! $r['echo'] ) {
return $html;
}
echo $html;
}