WP_Widget_Recent_Comments::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 Recent Comments widget instance.

Performance profile

How much work a call to WP_Widget_Recent_Comments::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_comments().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

77–132

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

Plugin surface

3 hooks

Third-party callbacks on 'widget_title', 'widget_comments_args', 'navigation_widgets_format' 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_comments()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below WP_Widget_Recent_Comments::widget()
• serializeserialisationmaybe_unserialize()one call below WP_Widget_Recent_Comments::widget()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 8 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Widget_Recent_Comments::widget() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while WP_Widget_Recent_Comments::widget() runs, in this order:

1. 1
   apply_filters( widget_title )filterline 85 (+13 into the body)

   Filters the widget title.

2. 2
   apply_filters( widget_comments_args )filterline 104 (+32 into the body)

   Filters the arguments for the Recent Comments widget.

3. 3
   apply_filters( navigation_widgets_format )filterline 126 (+54 into the body)

   Filters the HTML format of widgets with navigation links.

Uses · 14

• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• absint()Converts a value to non-negative integer.
• get_comments()Retrieves a list of comments.
• current_theme_supports()Checks a theme's support for a given feature.
• esc_attr()Escaping for HTML attributes.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• _prime_post_caches()Adds any posts from the given IDs to the cache that do not already exist in cache.
• get_option()Retrieves an option value based on an option name.
• _x()Retrieves translated string with gettext context.
• get_comment_author_link()Retrieves the HTML link to the URL of the author of the current comment.
• esc_url()Checks and cleans a URL.

Source code

View on Trac ↗View on GitHub ↗

72	public function widget( $args, $instance ) {73		static $first_instance = true;74 75		if ( ! isset( $args['widget_id'] ) ) {76			$args['widget_id'] = $this->id;77		}78 79		$output = '';80 81		$default_title = __( 'Recent Comments' );82		$title         = ( ! empty( $instance['title'] ) ) ? $instance['title'] : $default_title;83 84		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */85		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );86 87		$number = ( ! empty( $instance['number'] ) ) ? absint( $instance['number'] ) : 5;88		if ( ! $number ) {89			$number = 5;90		}91 92		$comments = get_comments(93			/**94			 * Filters the arguments for the Recent Comments widget.95			 *96			 * @since 3.4.097			 * @since 4.9.0 Added the `$instance` parameter.98			 *99			 * @see WP_Comment_Query::query() for information on accepted arguments.100			 *101			 * @param array $comment_args An array of arguments used to retrieve the recent comments.102			 * @param array $instance     Array of settings for the current widget.103			 */104			apply_filters(105				'widget_comments_args',106				array(107					'number'      => $number,108					'status'      => 'approve',109					'post_status' => 'publish',110				),111				$instance112			)113		);114 115		$output .= $args['before_widget'];116		if ( $title ) {117			$output .= $args['before_title'] . $title . $args['after_title'];118		}119 120		$recent_comments_id = ( $first_instance ) ? 'recentcomments' : "recentcomments-{$this->number}";121		$first_instance     = false;122 123		$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';124 125		/** This filter is documented in wp-includes/widgets/class-wp-nav-menu-widget.php */126		$format = apply_filters( 'navigation_widgets_format', $format );127 128		if ( 'html5' === $format ) {129			// The title may be filtered: Strip out HTML and make sure the aria-label is never empty.130			$title      = trim( strip_tags( $title ) );131			$aria_label = $title ? $title : $default_title;132			$output    .= '<nav aria-label="' . esc_attr( $aria_label ) . '">';133		}134 135		$output .= '<ul id="' . esc_attr( $recent_comments_id ) . '">';136		if ( is_array( $comments ) && $comments ) {137			// Prime cache for associated posts. (Prime post term cache if we need it for permalinks.)138			$post_ids = array_unique( wp_list_pluck( $comments, 'comment_post_ID' ) );139			_prime_post_caches( $post_ids, strpos( get_option( 'permalink_structure' ), '%category%' ), false );140 141			foreach ( (array) $comments as $comment ) {142				$output .= '<li class="recentcomments">';143				$output .= sprintf(144					/* translators: Comments widget. 1: Comment author, 2: Post link. */145					_x( '%1$s on %2$s', 'widgets' ),146					'<span class="comment-author-link">' . get_comment_author_link( $comment ) . '</span>',147					'<a href="' . esc_url( get_comment_link( $comment ) ) . '">' . get_the_title( $comment->comment_post_ID ) . '</a>'148				);149				$output .= '</li>';150			}151		}

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