wppaste
WordPress

WP_Comment_Query::query( string|array $query ): array|int

Since
3.1.0, 4.1.0, 4.2.0
Source
wp-includes/class-wp-comment-query.php:364
Sets up the WordPress query for retrieving comments.

Parameters

$querystring|array
Array or URL query string of parameters.

Return

array|int
List of comments, or number of comments when 'count' is passed as a query var.

Cost profile

Measured from the compiled opcodes, not from a stopwatch. Every number here is identical on any machine that runs the same PHP version, and every function in core is ranked by these figures.

Cost class
Heavy

Reaches the database via WP_Comment_Query::query().

Scaling
Constant

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

Instructions
9

Executed per call on PHP 8.4. The body compiles to 9.

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

  • sqldatabase queryWP_Comment_Query::query()this function does it

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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always9wp_parse_args()->get_comments()

Across PHP versions

PHPCompiledExecutedBranchesNotes
7.4990Compiles to the same instructions
8.1990Compiles to the same instructions
8.2990Compiles to the same instructions
8.3990Compiles to the same instructions
8.4990Compiles to the same instructions

Oldest PHP that compiles this body: 7.4. An instruction is not a fixed amount of time, so a version with the same count is not necessarily the same speed; what the count rules out is a difference in the work itself.

Uses · 2

Used by · 1

Source

View on Trac View on GitHub 

	public function query( $query ) {		$this->query_vars = wp_parse_args( $query );		return $this->get_comments();	}

History

Introduced in 4.1.0. One change between 6.7.7 and 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.

7.1.0
Return type changed from array|int to WP_Comment[]|int[]|int.verified against source
4.2.0
Moved parsing to WP_Comment_Query::parse_query().from the docblock
4.1.0
Introduced 'commentin', 'commentnot_in', 'post_authorin', 'post_author__not_in', 'authorin', 'author__not_in', 'postin', 'postnot_in', 'include_unapproved', 'typein', and 'typenot_in' arguments to $query_vars.from the docblock
3.1.0
Introduced.from the docblock

About this page

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