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

In this article

Outputs the content for the current Links widget instance.

Parameters

$argsarrayrequired
Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.
$instancearrayrequired
Settings for the current Links widget instance.

Source

public function widget( $args, $instance ) {
	$show_description = isset( $instance['description'] ) ? $instance['description'] : false;
	$show_name        = isset( $instance['name'] ) ? $instance['name'] : false;
	$show_rating      = isset( $instance['rating'] ) ? $instance['rating'] : false;
	$show_images      = isset( $instance['images'] ) ? $instance['images'] : true;
	$category         = isset( $instance['category'] ) ? $instance['category'] : false;
	$orderby          = isset( $instance['orderby'] ) ? $instance['orderby'] : 'name';
	$order            = 'rating' === $orderby ? 'DESC' : 'ASC';
	$limit            = isset( $instance['limit'] ) ? $instance['limit'] : -1;

	$before_widget = preg_replace( '/ id="[^"]*"/', ' id="%id"', $args['before_widget'] );

	$widget_links_args = array(
		'title_before'     => $args['before_title'],
		'title_after'      => $args['after_title'],
		'category_before'  => $before_widget,
		'category_after'   => $args['after_widget'],
		'show_images'      => $show_images,
		'show_description' => $show_description,
		'show_name'        => $show_name,
		'show_rating'      => $show_rating,
		'category'         => $category,
		'class'            => 'linkcat widget',
		'orderby'          => $orderby,
		'order'            => $order,
		'limit'            => $limit,
	);

	/**
	 * Filters the arguments for the Links widget.
	 *
	 * @since 2.6.0
	 * @since 4.4.0 Added the `$instance` parameter.
	 *
	 * @see wp_list_bookmarks()
	 *
	 * @param array $widget_links_args An array of arguments to retrieve the links list.
	 * @param array $instance          The settings for the particular instance of the widget.
	 */
	wp_list_bookmarks( apply_filters( 'widget_links_args', $widget_links_args, $instance ) );
}

Hooks

apply_filters( ‘widget_links_args’, array $widget_links_args, array $instance )

Filters the arguments for the Links widget.

Changelog

VersionDescription
2.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.