/**
* Gets the links associated with category by id.
*
* @since 0.71
* @deprecated 2.1
* @deprecated Use get_bookmarks()
* @see get_bookmarks()
*
* @param int $category The category to use. If no category supplied uses all
* @param string $before the html to output before the link
* @param string $after the html to output after the link
* @param string $between the html to output between the link/image and its description.
* Not used if no image or show_images == true
* @param bool $show_images whether to show images (if defined).
* @param string $orderby the order to output the links. E.g. 'id', 'name', 'url',
* 'description', or 'rating'. Or maybe owner. If you start the name with an
* underscore the order will be reversed. You can also specify 'rand' as the order
* which will return links in a random order.
* @param bool $show_description whether to show the description if show_images=false/not defined.
* @param bool $show_rating show rating stars/chars
* @param int $limit Limit to X entries. If not specified, all entries are shown.
* @param int $show_updated whether to show last updated timestamp
* @param bool $echo whether to echo the results, or return them instead
* @return null|string
*/
function get_links($category = -1, $before = '', $after = '<br />', $between = ' ', $show_images = true, $orderby = 'name', $show_description = true, $show_rating = false, $limit = -1, $show_updated = 1, $echo = true)
{
_deprecated_function(__FUNCTION__, '2.1', 'get_bookmarks()');
$order = 'ASC';
if (substr($orderby, 0, 1) == '_') {
$order = 'DESC';
$orderby = substr($orderby, 1);
}
if ($category == -1) {
//get_bookmarks uses '' to signify all categories
$category = '';
}
$results = get_bookmarks(array('category' => $category, 'orderby' => $orderby, 'order' => $order, 'show_updated' => $show_updated, 'limit' => $limit));
if (!$results) {
return;
}
$output = '';
foreach ((array) $results as $row) {
if (!isset($row->recently_updated)) {
$row->recently_updated = false;
}
$output .= $before;
if ($show_updated && $row->recently_updated) {
$output .= get_option('links_recently_updated_prepend');
}
$the_link = '#';
if (!empty($row->link_url)) {
$the_link = esc_url($row->link_url);
}
$rel = $row->link_rel;
if ('' != $rel) {
$rel = ' rel="' . $rel . '"';
}
$desc = esc_attr(sanitize_bookmark_field('link_description', $row->link_description, $row->link_id, 'display'));
$name = esc_attr(sanitize_bookmark_field('link_name', $row->link_name, $row->link_id, 'display'));
$title = $desc;
if ($show_updated) {
if (substr($row->link_updated_f, 0, 2) != '00') {
$title .= ' (' . __('Last updated') . ' ' . date(get_option('links_updated_date_format'), $row->link_updated_f + get_option('gmt_offset') * HOUR_IN_SECONDS) . ')';
}
}
if ('' != $title) {
$title = ' title="' . $title . '"';
}
$alt = ' alt="' . $name . '"';
$target = $row->link_target;
if ('' != $target) {
$target = ' target="' . $target . '"';
}
$output .= '<a href="' . $the_link . '"' . $rel . $title . $target . '>';
if ($row->link_image != null && $show_images) {
if (strpos($row->link_image, 'http') !== false) {
$output .= "<img src=\"{$row->link_image}\" {$alt} {$title} />";
} else {
// If it's a relative path
$output .= "<img src=\"" . get_option('siteurl') . "{$row->link_image}\" {$alt} {$title} />";
}
} else {
$output .= $name;
}
$output .= '</a>';
if ($show_updated && $row->recently_updated) {
$output .= get_option('links_recently_updated_append');
}
if ($show_description && '' != $desc) {
$output .= $between . $desc;
}
if ($show_rating) {
$output .= $between . get_linkrating($row);
}
$output .= "{$after}\n";
}
// end while
if (!$echo) {
return $output;
}
echo $output;
}
/**
* _walk_bookmarks() - The formatted output of a list of bookmarks
*
* The $bookmarks array must contain bookmark objects and will be iterated over
* to retrieve the bookmark to be used in the output.
*
* The output is formatted as HTML with no way to change that format. However, what
* is between, before, and after can be changed. The link itself will be HTML.
*
* This function is used internally by wp_list_bookmarks() and should not be used by
* themes.
*
* The defaults for overwriting are:
* 'show_updated' - Default is 0 (integer). Will show the time of when the bookmark was last updated.
* 'show_description' - Default is 0 (integer). Whether to show the description of the bookmark.
* 'show_images' - Default is 1 (integer). Whether to show link image if available.
* 'before' - Default is '<li>' (string). The html or text to prepend to each bookmarks.
* 'after' - Default is '</li>' (string). The html or text to append to each bookmarks.
* 'between' - Default is '\n' (string). The string for use in between the link, description, and image.
* 'show_rating' - Default is 0 (integer). Whether to show the link rating.
*
* @since 2.1
* @access private
* @usedby wp_list_bookmarks()
*
* @param array $bookmarks List of bookmarks to traverse
* @param string|array $args Optional. Overwrite the defaults.
* @return string Formatted output in HTML
*/
function _walk_bookmarks($bookmarks, $args = '' ) {
$defaults = array(
'show_updated' => 0, 'show_description' => 0,
'show_images' => 1, 'before' => '<li>',
'after' => '</li>', 'between' => "\n",
'show_rating' => 0
);
$r = wp_parse_args( $args, $defaults );
extract( $r, EXTR_SKIP );
$output = ''; // Blank string to start with.
foreach ( (array) $bookmarks as $bookmark ) {
if ( !isset($bookmark->recently_updated) )
$bookmark->recently_updated = false;
$output .= $before;
if ( $show_updated && $bookmark->recently_updated )
$output .= get_option('links_recently_updated_prepend');
$the_link = '#';
if ( !empty($bookmark->link_url) )
$the_link = clean_url($bookmark->link_url);
$rel = $bookmark->link_rel;
if ( '' != $rel )
$rel = ' rel="' . $rel . '"';
$desc = attribute_escape(sanitize_bookmark_field('link_description', $bookmark->link_description, $bookmark->link_id, 'display'));
$name = attribute_escape(sanitize_bookmark_field('link_name', $bookmark->link_name, $bookmark->link_id, 'display'));
$title = $desc;
if ( $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') * 3600)));
$title .= ')';
}
if ( '' != $title )
$title = ' title="' . $title . '"';
$alt = ' alt="' . $name . '"';
$target = $bookmark->link_target;
if ( '' != $target )
$target = ' target="' . $target . '"';
$output .= '<a href="' . $the_link . '"' . $rel . $title . $target. '>';
if ( $bookmark->link_image != null && $show_images ) {
if ( strpos($bookmark->link_image, 'http') !== false )
$output .= "<img src=\"$bookmark->link_image\" $alt $title />";
else // If it's a relative path
$output .= "<img src=\"" . get_option('siteurl') . "$bookmark->link_image\" $alt $title />";
} else {
$output .= $name;
}
$output .= '</a>';
if ( $show_updated && $bookmark->recently_updated )
$output .= get_option('links_recently_updated_append');
if ( $show_description && '' != $desc )
$output .= $between . $desc;
if ($show_rating) {
$output .= $between . get_linkrating($bookmark);
}
$output .= "$after\n";
} // end while
return $output;
}
function _walk_bookmarks($bookmarks, $args = '')
{
if (is_array($args)) {
$r =& $args;
} else {
parse_str($args, $r);
}
$defaults = array('show_updated' => 0, 'show_description' => 0, 'show_images' => 1, 'before' => '<li>', 'after' => '</li>', 'between' => "\n");
$r = array_merge($defaults, $r);
extract($r, EXTR_SKIP);
foreach ((array) $bookmarks as $bookmark) {
if (!isset($bookmark->recently_updated)) {
$bookmark->recently_updated = false;
}
$output .= $before;
if ($show_updated && $bookmark->recently_updated) {
$output .= get_option('links_recently_updated_prepend');
}
$the_link = '#';
if (!empty($bookmark->link_url)) {
$the_link = clean_url($bookmark->link_url);
}
$rel = $bookmark->link_rel;
if ('' != $rel) {
$rel = ' rel="' . $rel . '"';
}
$desc = attribute_escape(apply_filters('link_description', $bookmark->link_description));
$name = attribute_escape(apply_filters('link_title', $bookmark->link_name));
$title = $desc;
if ($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') * 3600));
$title .= ')';
}
}
if ('' != $title) {
$title = ' title="' . $title . '"';
}
$alt = ' alt="' . $name . '"';
$target = $bookmark->link_target;
if ('' != $target) {
$target = ' target="' . $target . '"';
}
$output .= '<a href="' . $the_link . '"' . $rel . $title . $target . '>';
if ($bookmark->link_image != null && $show_images) {
if (strpos($bookmark->link_image, 'http') !== false) {
$output .= "<img src=\"{$bookmark->link_image}\" {$alt} {$title} />";
} else {
// If it's a relative path
$output .= "<img src=\"" . get_option('siteurl') . "{$bookmark->link_image}\" {$alt} {$title} />";
}
} else {
$output .= $name;
}
$output .= '</a>';
if ($show_updated && $bookmark->recently_updated) {
$output .= get_option('links_recently_updated_append');
}
if ($show_description && '' != $desc) {
$output .= $between . $desc;
}
if ($show_rating) {
$output .= $between . get_linkrating($bookmark);
}
$output .= "{$after}\n";
}
// end while
return $output;
}
/**
* get_links() - Gets the links associated with category by id.
*
* @since 0.71
* @deprecated Use get_bookmarks()
* @see get_bookmarks()
*
* @param int $category The category to use. If no category supplied uses all
* @param string $before the html to output before the link
* @param string $after the html to output after the link
* @param string $between the html to output between the link/image and its description.
* Not used if no image or show_images == true
* @param bool $show_images whether to show images (if defined).
* @param string $orderby the order to output the links. E.g. 'id', 'name', 'url',
* 'description', or 'rating'. Or maybe owner. If you start the name with an
* underscore the order will be reversed. You can also specify 'rand' as the order
* which will return links in a random order.
* @param bool $show_description whether to show the description if show_images=false/not defined.
* @param bool $show_rating show rating stars/chars
* @param int $limit Limit to X entries. If not specified, all entries are shown.
* @param int $show_updated whether to show last updated timestamp
* @param bool $echo whether to echo the results, or return them instead
* @return null|string
*/
function get_links($category = -1, $before = '', $after = '<br />', $between = ' ', $show_images = true, $orderby = 'name',
$show_description = true, $show_rating = false, $limit = -1, $show_updated = 1, $echo = true) {
_deprecated_function(__FUNCTION__, '0.0', 'get_bookmarks()');
$order = 'ASC';
if ( substr($orderby, 0, 1) == '_' ) {
$order = 'DESC';
$orderby = substr($orderby, 1);
}
if ( $category == -1 ) //get_bookmarks uses '' to signify all categories
$category = '';
$results = get_bookmarks("category=$category&orderby=$orderby&order=$order&show_updated=$show_updated&limit=$limit");
if ( !$results )
return;
$output = '';
foreach ( (array) $results as $row ) {
if ( !isset($row->recently_updated) )
$row->recently_updated = false;
$output .= $before;
if ( $show_updated && $row->recently_updated )
$output .= get_option('links_recently_updated_prepend');
$the_link = '#';
if ( !empty($row->link_url) )
$the_link = clean_url($row->link_url);
$rel = $row->link_rel;
if ( '' != $rel )
$rel = ' rel="' . $rel . '"';
$desc = attribute_escape(sanitize_bookmark_field('link_description', $row->link_description, $row->link_id, 'display'));
$name = attribute_escape(sanitize_bookmark_field('link_name', $row->link_name, $row->link_id, 'display'));
$title = $desc;
if ( $show_updated )
if (substr($row->link_updated_f, 0, 2) != '00')
$title .= ' ('.__('Last updated') . ' ' . date(get_option('links_updated_date_format'), $row->link_updated_f + (get_option('gmt_offset') * 3600)) . ')';
if ( '' != $title )
$title = ' title="' . $title . '"';
$alt = ' alt="' . $name . '"';
$target = $row->link_target;
if ( '' != $target )
$target = ' target="' . $target . '"';
$output .= '<a href="' . $the_link . '"' . $rel . $title . $target. '>';
if ( $row->link_image != null && $show_images ) {
if ( strpos($row->link_image, 'http') !== false )
$output .= "<img src=\"$row->link_image\" $alt $title />";
else // If it's a relative path
$output .= "<img src=\"" . get_option('siteurl') . "$row->link_image\" $alt $title />";
} else {
$output .= $name;
}
$output .= '</a>';
if ( $show_updated && $row->recently_updated )
$output .= get_option('links_recently_updated_append');
if ( $show_description && '' != $desc )
$output .= $between . $desc;
if ($show_rating) {
$output .= $between . get_linkrating($row);
}
$output .= "$after\n";
} // end while
if ( !$echo )
return $output;
echo $output;
}
