wppaste
WordPress

get_linkobjectsbyname( string $cat_name = "noname", string $orderby = 'name', int $limit = -1 ): array

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

Description

$links = get_linkobjectsbyname( 'fred' ); foreach ( $links as $link ) { echo '

  • ' . $link->link_name . '
    • '; }

    Compatibility

    Deprecated in WordPress 2.1.0. Use get_bookmarks()

    WordPress
    since 1.0.1
    PHP
    7.4–8.6-dev
    • 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.6-dev.

    Parameters

    $cat_namestringoptional
    The category name to use. If no match is found, uses all.
    Default 'noname'.Default: "noname"
    $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 -1.Default: -1

    Return value

    array

    Performance profile

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

    Scaling
    Constant

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

    Instructions
    22–23

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

    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_linkobjectsbyname()
    • querycontent queryget_term()one call below get_linkobjectsbyname()

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

    WhenInstructionsCalls it makes
    always22–23_deprecated_function(), get_term_by(), get_linkobjects()

    Across PHP versions

    Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 23 instructions, 22–23 executed per call, 1 branch. 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 · 3

    Source code

    View on Trac View on GitHub 

    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);}

    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.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.