wppaste
WordPress

get_linkobjects( int $category = 0, string $orderby = 'name', int $limit = 0 ): array

Since
1.0.1
Source
wp-includes/deprecated.php:520
Gets an array of link objects associated with category n.

Description

Usage:

$links = get_linkobjects(1);
if ($links) {
 foreach ($links as $link) {
 echo '<li>'.$link->link_name.'<br />'.$link->link_description.'</li>';
 }
}

Fields are:

  • link_id
  • link_url
  • link_name
  • link_image
  • link_target
  • link_category
  • link_description
  • link_visible
  • link_owner
  • link_rating
  • link_updated
  • link_rel
  • link_notes

Compatibility

Deprecated in WordPress 2.1.0. Use get_bookmarks()

WordPress
since 1.0.1
PHP
7.4–8.4
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.4.

Parameters

$categoryintoptional
The category to use. If no category supplied, uses all.
Default 0.Default: 0
$orderbystringoptional
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.Default: 'name'
$limitintoptional
Limit to X entries. If not specified, all entries are shown.
Default 0.Default: 0

Return value

array

Performance profile

How much work a call to get_linkobjects() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Moderate

Only touches the object cache, via wp_cache_get().

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
19–20

Executed per call on PHP 8.4, depending on the branch taken. The body compiles to 23.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksdo_action()one call below get_linkobjects()
  • cacheobject cachewp_cache_get()one call below get_linkobjects()

Further down the call graph this can also reach query, option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_linkobjects() can have, taken from its control-flow graph on PHP 8.4.

WhenInstructionsCalls it makes
always19–20_deprecated_function(), category()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3 and 8.4: 23 instructions, 19–20 executed per call, 2 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 1

Source code

View on Trac View on GitHub 

function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) {	_deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' ); 	$links = get_bookmarks( array( 'category' => $category, 'orderby' => $orderby, 'limit' => $limit ) ) ; 	$links_array = array();	foreach ($links as $link)		$links_array[] = $link; 	return $links_array;}

Changelog

Introduced in 1.0.1. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

2.1.0
Deprecated. Use get_bookmarks()from the docblock
1.0.1
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.