wppaste
WordPress

get_approved_comments( int $post_id, array $args = array() ): WP_Comment[]|int[]|int

Since
2.0.0, 4.1.0
Source
wp-includes/comment.php:188
Retrieves the approved comments for a post.

Compatibility

WordPress
since 4.1.0
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

$post_idint
The ID of the post.
$argsarrayoptional
See WP_Comment_Query::__construct() for information on accepted arguments.Default: array()

  • $statusint

    Comment status to limit results by. Defaults to approved comments.

  • $post_idint

    Limit results to those affiliated with a given post ID.

  • $orderstringdefault: 'ASC'

    How to order retrieved comments.

Return value

WP_Comment[]|int[]|int
The approved comments, or number of comments if $count argument is true.

Performance profile

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

Scaling
Constant

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

Instructions
4–19

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

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

  • sqldatabase query->query()called directly

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

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always4none
always19wp_parse_args(), status(), ->query()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 20 instructions, 4–19 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 · 2

Source code

View on Trac View on GitHub 

function get_approved_comments( $post_id, $args = array() ) {	if ( ! $post_id ) {		return array();	} 	$defaults    = array(		'status'  => 1,		'post_id' => $post_id,		'order'   => 'ASC',	);	$parsed_args = wp_parse_args( $args, $defaults ); 	$query = new WP_Comment_Query();	return $query->query( $parsed_args );}

Changelog

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

4.1.0
Refactored to leverage WP_Comment_Query over a direct query.from the docblock
2.0.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/comment.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.