A WordPress-centric search engine for devs and theme authors



get_links ›

Since0.71
Deprecated2.1.0
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 )
Parameters: (11)
  • (int) $category The category to use. If no category supplied uses all
    Required: No
    Default: -1
  • (string) $before the html to output before the link
    Required: No
    Default: (empty)
  • (string) $after the html to output after the link
    Required: No
    Default: '<br />'
  • (string) $between the html to output between the link/image and its description. Not used if no image or show_images == true
    Required: No
    Default: ' '
  • (bool) $show_images whether to show images (if defined).
    Required: No
    Default: true
  • (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.
    Required: No
    Default: 'name'
  • (bool) $show_description whether to show the description if show_images=false/not defined.
    Required: No
    Default: true
  • (bool) $show_rating show rating stars/chars
    Required: No
    Default: false
  • (int) $limit Limit to X entries. If not specified, all entries are shown.
    Required: No
    Default: -1
  • (int) $show_updated whether to show last updated timestamp
    Required: No
    Default: 1
  • (bool) $echo whether to echo the results, or return them instead
    Required: No
    Default: true
See:
Returns:
  • (null|string)
Defined at:
Codex:

Gets the links associated with category by id.



Source

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.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(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;
}