get_linksbyname_withrating

Definition:
function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = '<br />', $between = " ",

Gets the links associated with category ‘cat_name’ and display rating stars/chars.

Parameters

  • string $cat_name: The category name to use. If no match is found uses all
  • string $before: The html to output before the link
  • string $after: The html to output after the link
  • string $between: The html to output between the link/image and it’s description. Not used if no image or show_images is true
  • bool $show_images: Whether to show images (if defined).
  • 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.
  • bool $show_description: Whether to show the description if show_images=false/not defined
  • int $limit: Limit to X entries. If not specified, all entries are shown.
  • int $show_updated: Whether to show last updated timestamp

Source code

function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = '<br />', $between = " ",

									$show_images = true, $orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) {

	_deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );



	get_linksbyname($cat_name, $before, $after, $between, $show_images, $orderby, $show_description, true, $limit, $show_updated);

}

1462

get_linksbyname

Definition:
function get_linksbyname($cat_name = "noname", $before = '', $after = '<br />', $between = " ", $show_images = true, $orderby = 'id',

Gets the links associated with category $cat_name.

Parameters

  • string $cat_name: Optional. The category name to use. If no match is found uses all.
  • string $before: Optional. The html to output before the link.
  • string $after: Optional. The html to output after the link.
  • string $between: Optional. The html to output between the link/image and it’s description. Not used if no image or $show_images is true.
  • bool $show_images: Optional. Whether to show images (if defined).
  • string $orderby: Optional. 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.
  • bool $show_description: Optional. Whether to show the description if show_images=false/not defined.
  • bool $show_rating: Optional. Show rating stars/chars.
  • int $limit: Optional. Limit to X entries. If not specified, all entries are shown.
  • int $show_updated: Optional. Whether to show last updated timestamp

Source code

function get_linksbyname($cat_name = "noname", $before = '', $after = '<br />', $between = " ", $show_images = true, $orderby = 'id',

						 $show_description = true, $show_rating = false,

						 $limit = -1, $show_updated = 0) {

	_deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );



	$cat_id = -1;

	$cat = get_term_by('name', $cat_name, 'link_category');

	if ( $cat )

		$cat_id = $cat->term_id;



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

}

1460

get_links

Definition:
function get_links($category = -1, $before = '', $after = '<br />', $between = ' ', $show_images = true, $orderby = 'name',

Gets the links associated with category by id.

Parameters

  • int $category: The category to use. If no category supplied uses all
  • string $before: the html to output before the link
  • string $after: the html to output after the link
  • string $between: the html to output between the link/image and its description. Not used if no image or show_images == true
  • bool $show_images: whether to show images (if defined).
  • 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.
  • bool $show_description: whether to show the description if show_images=false/not defined.
  • bool $show_rating: show rating stars/chars
  • int $limit: Limit to X entries. If not specified, all entries are shown.
  • int $show_updated: whether to show last updated timestamp
  • bool $echo: whether to echo the results, or return them instead

Source code

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') * 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;

}

1458

get_linkrating

Definition:
function get_linkrating($link) {}

Parameters

  • object $link

Source code

function get_linkrating($link) {

	_deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' );

	return sanitize_bookmark_field('link_rating', $link->link_rating, $link->link_id, 'display');

}

1456

get_linkobjectsbyname

Definition:
function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) {}

Gets an array of link objects associated with category $cat_name.

Parameters

  • string $cat_name: The category name to use. If no match is found uses all.
  • 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.
  • int $limit: Limit to X entries. If not specified, all entries are shown.

Source code

function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) {

	_deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );



	$cat_id = -1;

	$cat = get_term_by('name', $cat_name, 'link_category');

	if ( $cat )

		$cat_id = $cat->term_id;



	return get_linkobjects($cat_id, $orderby, $limit);

}

1454