wp_dashboard_recent_comments( int $total_items = 5 ): bool

Compatibility

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

Parameters

$total_itemsintoptional

Number of comments to query. Default 5.Default: 5

Return value

bool

False if no comments were found. True otherwise.

Performance profile

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

19–88

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_comments()called directly
• hookthird-party callbacksapply_filters()one call below wp_dashboard_recent_comments()
• optionoption read or writeget_option()one call below wp_dashboard_recent_comments()

Further down the call graph this can also reach cache, 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 · 9 distinct outcomes

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

Uses · 9

• current_user_can()Returns whether the current user has the specified capability.
• get_comments()Retrieves a list of comments.
• post_password_required()Determines whether the post requires password and whether a correct password has been provided.
• __()Retrieves the translation of $text.
• _wp_dashboard_recent_comments_row()Outputs a row for the Recent Comments widget.
• _get_list_table()Fetches an instance of a WP_List_Table class.
• wp_comment_reply()Outputs the in-line comment reply-to form in the Comments list table.
• wp_comment_trashnotice()Outputs 'undo move to Trash' text for comments.
• _get_list_table('WP_Comments_List_Table')::views()

Used by · 1

• wp_dashboard_site_activity()Outputs the Activity widget.

Source code

View on Trac ↗View on GitHub ↗

1064function wp_dashboard_recent_comments( $total_items = 5 ) {1065	// Select all comment types and filter out spam later for better query performance.1066	$comments = array();1067 1068	$comments_query = array(1069		'number' => $total_items * 5,1070		'offset' => 0,1071	);1072 1073	if ( ! current_user_can( 'edit_posts' ) ) {1074		$comments_query['status'] = 'approve';1075	}1076 1077	$comments_count = 0;1078	do {1079		$possible = get_comments( $comments_query );1080 1081		if ( empty( $possible ) || ! is_array( $possible ) ) {1082			break;1083		}1084 1085		foreach ( $possible as $comment ) {1086			if ( ! current_user_can( 'edit_post', $comment->comment_post_ID )1087				&& ( post_password_required( $comment->comment_post_ID )1088					|| ! current_user_can( 'read_post', $comment->comment_post_ID ) )1089			) {1090				// The user has no access to the post and thus cannot see the comments.1091				continue;1092			}1093 1094			$comments[]     = $comment;1095			$comments_count = count( $comments );1096 1097			if ( $comments_count === $total_items ) {1098				break 2;1099			}1100		}1101 1102		$comments_query['offset'] += $comments_query['number'];1103		$comments_query['number']  = $total_items * 10;1104	} while ( $comments_count < $total_items );1105 1106	if ( $comments ) {1107		echo '<div id="latest-comments" class="activity-block table-view-list">';1108		echo '<h3>' . __( 'Recent Comments' ) . '</h3>';1109 1110		echo '<ul id="the-comment-list" data-wp-lists="list:comment">';1111		foreach ( $comments as $comment ) {1112			_wp_dashboard_recent_comments_row( $comment );1113		}1114		echo '</ul>';1115 1116		if ( current_user_can( 'edit_posts' ) ) {1117			echo '<h3 class="screen-reader-text">' .1118				/* translators: Hidden accessibility text. */1119				__( 'View more comments' ) .1120			'</h3>';1121			_get_list_table( 'WP_Comments_List_Table' )->views();1122		}1123 1124		wp_comment_reply( -1, false, 'dashboard', false );1125		wp_comment_trashnotice();1126 1127		echo '</div>';1128	} else {1129		return false;1130	}1131	return true;1132}

Changelog

Introduced in 3.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 6.9.7 tag, from src/wp-admin/includes/dashboard.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.