get_links_withrating( int $category = -1, string $before = '', string $after = '<br />', string $between = " ", bool $show_images = true, string $orderby = 'id', bool $show_description = true, int $limit = -1, int $show_updated = 0 )

Compatibility

Deprecated in WordPress 2.1.0. Use get_bookmarks()

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

Parameters

$categoryintoptional

The category to use. If no category supplied, uses all.
Default 0.Default: -1

$beforestringoptional

The HTML to output before the link. Default empty.Default: ''

$afterstringoptional

The HTML to output after the link. Default '
'.Default: '<br />'

$betweenstringoptional

The HTML to output between the link/image and its description.
Not used if no image or $show_images is true. Default ' '.Default: " "

$show_imagesbooloptional

Whether to show images (if defined). Default true.Default: true

$orderbystringoptional

The order to output the links. E.g. 'id', 'name', 'url', 'description', 'rating', or 'owner'. Default 'id'.
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: 'id'

$show_descriptionbooloptional

Whether to show the description if show_images=false/not defined.
Default true.Default: true

$limitintoptional

Limit to X entries. If not specified, all entries are shown.
Default -1.Default: -1

$show_updatedintoptional

Whether to show last updated timestamp. Default 0.Default: 0

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

27

Executed per call on PHP 8.5. The body compiles to 27.

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_links_withrating()
• optionoption read or writeget_option()one call below get_links_withrating()

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

Uses · 2

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• get_links()Gets the links associated with category by ID.

Source code

View on Trac ↗View on GitHub ↗

587function get_links_withrating($category = -1, $before = '', $after = '<br />', $between = " ", $show_images = true,588							$orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) {589	_deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' );590 591	get_links($category, $before, $after, $between, $show_images, $orderby, $show_description, true, $limit, $show_updated);592}

Changelog

Introduced in 0.71. 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.

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.