wpseek.com
A WordPress-centric search engine for devs and theme authors



get_links › WordPress Function

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, $display = true )
Parameters: (11)
  • (int) $category Optional. The category to use. If no category supplied uses all. Default 0.
    Required: No
    Default: -1
  • (string) $before Optional. The HTML to output before the link. Default empty.
    Required: No
    Default: (empty)
  • (string) $after Optional. The HTML to output after the link. Default '&lt;br /&gt;'.
    Required: No
    Default: '<br />'
  • (string) $between Optional. The HTML to output between the link/image and its description. Not used if no image or $show_images is true. Default ' '.
    Required: No
    Default: ' '
  • (bool) $show_images Optional. Whether to show images (if defined). Default true.
    Required: No
    Default: true
  • (string) $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description', 'rating', or 'owner'. Default 'name'. 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.
    Required: No
    Default: 'name'
  • (bool) $show_description Optional. Whether to show the description if show_images=false/not defined. Default true.
    Required: No
    Default: true
  • (bool) $show_rating Optional. Show rating stars/chars. Default false.
    Required: No
    Default: false
  • (int) $limit Optional. Limit to X entries. If not specified, all entries are shown. Default -1.
    Required: No
    Default: -1
  • (int) $show_updated Optional. Whether to show last updated timestamp. Default 1.
    Required: No
    Default: 1
  • (bool) $display Whether to display 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.



Related Functions: get_link, wp_get_links, get_plugins, get_links_list, edit_link

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, $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;
}