wppaste
WordPress

get_link( int $bookmark_id, string $output = OBJECT, string $filter = 'raw' ): object|array

Since
2.0.0
Source
wp-includes/deprecated.php:2023
Retrieves bookmark data based on ID.

Compatibility

Deprecated in WordPress 2.1.0. Use get_bookmark()

WordPress
since 2.0.0
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

$bookmark_idint
ID of link
$outputstringoptional
Type of output. Accepts OBJECT, ARRAY_N, or ARRAY_A.
Default OBJECT.Default: OBJECT
$filterstringoptional
How to filter the link for output. Accepts 'raw', 'edit', 'attribute', 'js', 'db', or 'display'. Default 'raw'.Default: 'raw'

Return value

object|array
Bookmark object or array, depending on the type specified by $output.

Performance profile

How much work a call to get_link() 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
Heavy

Reaches the database via wp_get_object_terms().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
14

Executed per call on PHP 8.4. The body compiles to 14.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksdo_action()one call below get_link()
  • cacheobject cachewp_cache_add()one call below get_link()
  • querycontent querywp_get_object_terms()one call below get_link()

Further down the call graph this can also reach 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_link() can have, taken from its control-flow graph on PHP 8.4.

WhenInstructionsCalls it makes
always14_deprecated_function(), get_bookmark()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3 and 8.4: 14 instructions, 14 executed per call, 0 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

Source code

View on Trac View on GitHub 

function get_link( $bookmark_id, $output = OBJECT, $filter = 'raw' ) {	_deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmark()' );	return get_bookmark($bookmark_id, $output, $filter);}

Changelog

Introduced in 2.0.0. 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_bookmark()from the docblock
2.0.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 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.