WP_Widget_Links::widget( array $args, array $instance )

Compatibility

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

Parameters

$argsarray

Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.

$instancearray

Settings for the current Links widget instance.

Performance profile

How much work a call to WP_Widget_Links::widget() 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_terms().

Scaling

Constant

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

Instructions

56–64

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

Plugin surface

1 hook

Third-party callbacks on 'widget_links_args' run inside this call, and their cost is not bounded by anything here.

Called by

0

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_terms()one call below WP_Widget_Links::widget()

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 WP_Widget_Links::widget() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_Widget_Links::widget() runs, in this order:

1. 1
   apply_filters( widget_links_args )filterline 80 (+39 into the body)

   Filters the arguments for the Links widget.

Uses · 2

• wp_list_bookmarks()Retrieves or echoes all of the bookmarks.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

View on Trac ↗View on GitHub ↗

41	public function widget( $args, $instance ) {42		$show_description = $instance['description'] ?? false;43		$show_name        = $instance['name'] ?? false;44		$show_rating      = $instance['rating'] ?? false;45		$show_images      = $instance['images'] ?? true;46		$category         = $instance['category'] ?? false;47		$orderby          = $instance['orderby'] ?? 'name';48		$order            = 'rating' === $orderby ? 'DESC' : 'ASC';49		$limit            = $instance['limit'] ?? -1;50 51		$before_widget = preg_replace( '/ id="[^"]*"/', ' id="%id"', $args['before_widget'] );52 53		$widget_links_args = array(54			'title_before'     => $args['before_title'],55			'title_after'      => $args['after_title'],56			'category_before'  => $before_widget,57			'category_after'   => $args['after_widget'],58			'show_images'      => $show_images,59			'show_description' => $show_description,60			'show_name'        => $show_name,61			'show_rating'      => $show_rating,62			'category'         => $category,63			'class'            => 'linkcat widget',64			'orderby'          => $orderby,65			'order'            => $order,66			'limit'            => $limit,67		);68 69		/**70		 * Filters the arguments for the Links widget.71		 *72		 * @since 2.6.073		 * @since 4.4.0 Added the `$instance` parameter.74		 *75		 * @see wp_list_bookmarks()76		 *77		 * @param array $widget_links_args An array of arguments to retrieve the links list.78		 * @param array $instance          The settings for the particular instance of the widget.79		 */80		wp_list_bookmarks( apply_filters( 'widget_links_args', $widget_links_args, $instance ) );81	}

Changelog

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

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/widgets/class-wp-widget-links.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.