Warning: This function has been deprecated. Use get_bookmarks() instead.
get_linkobjectsbyname() WordPress Function
The get_linkobjectsbyname() function is used to return an array of link objects matching a specified link name. It accepts a single string parameter, which is the name of the link to search for. If no links are found matching the specified name, an empty array is returned.
get_linkobjectsbyname( string $cat_name = "noname", string $orderby = 'name', int $limit = -1 ) #
Gets an array of link objects associated with category $cat_name.
Description
$links = get_linkobjectsbyname( ‘fred’ ); foreach ( $links as $link ) { echo ‘
‘; }
See also
Parameters
- $cat_name
(string)(Optional) The category name to use. If no match is found, uses all. Default 'noname'.
Default value: "noname"
- $orderby
(string)(Optional) 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 value: 'name'
- $limit
(int)(Optional) Limit to X entries. If not specified, all entries are shown.
Default value: -1
Return
(array)
Source
File: wp-includes/deprecated.php
function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) {
_deprecated_function( __FUNCTION__, '2.1.0', '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);
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.1.0 | Use get_bookmarks() |
| 1.0.1 | Introduced. |