get_links() │ WP 0.71

Gets the links associated with category by ID.

No Hooks.

Returns

null|String.

Usage

get_links( $category, $before, $after, $between, $show_images, $orderby, $show_description, $show_rating, $limit, $show_updated, $display );

$category(int)

The category to use. If no category supplied uses all.

$before(string)

The HTML to output before the link.
Default: ''

$after(string)

The HTML to output after the link.
Default: '<br />'

$between(string)

The HTML to output between the link/image and its description. Not used if no image or $show_images is true.
Default: ' '

$show_images(true|false)

Whether to show images (if defined).
Default: true

$orderby(string)

The order to output the links. E.g. 'id', 'name', 'url', 'description', 'rating', or 'owner'. If you start the name with an underscore, the order will be reversed. Specifying 'rand' as the order will return links in a random order.
Default: 'name'

$show_description(true|false)

Whether to show the description if show_images=false/not defined.
Default: true

$show_rating(true|false)

Show rating stars/chars.
Default: false

$limit(int)

Limit to X entries. If not specified, all entries are shown.
Default: -1

$show_updated(int)

Whether to show last updated timestamp.
Default: 1

$display(true|false)

Whether to display the results, or return them instead.
Default: true

Notes

• See: get_bookmarks()

Changelog

get_links() get links code ^{WP 7.0.2}

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, $display = true) {
	_deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' );

	$order = 'ASC';
	if ( str_starts_with($orderby, '_') ) {
		$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 ( !str_starts_with($row->link_updated_f, '00') )
				$title .= ' ('.__('Last updated') . ' ' . gmdate(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 && $show_images ) {
			if ( str_contains( $row->link_image, 'http' ) )
				$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 ( !$display )
		return $output;
	echo $output;
}