get_comments( string|array $args = '' ): WP_Comment[]|int[]|int
- Since
- 2.7.0
- Source
wp-includes/comment.php:268
Description
The comment list can be for the blog as a whole or for an individual post.
Compatibility
- WordPress
- since 2.7.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
$argsstring|arrayoptional- Array or string of arguments. See WP_Comment_Query::__construct() for information on accepted arguments. Default empty string.Default:
''
Return value
WP_Comment[]|int[]|int- List of comments or number of found comments if
$countargument is true.
Performance profile
How much work a call to get_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
- Trivial
- Scaling
- Constant
- Instructions
- 8
- Plugin surface
- None
- Called by
- 15
Reaches the database via ->query().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 8.
Nothing here hands control to plugin code.
15 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_comments()this function does it - sqldatabase query
->query()called directly
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 get_comments() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 8 | ->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: 8 instructions, 8 executed per call, 0 branches. 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 · 1
- WP_Comment_Query::__construct()Constructor.
Used by · 15
- WP_Comment::get_children()Gets the children of a comment.
- WP_Comment_Query::fill_descendants()Fetch descendants for located comments.
- WP_Comments_List_Table::comment_type_dropdown()Displays a comment type drop-down for filtering on the Comments list table.
- WP_Comments_List_Table::get_views()
- WP_Comments_List_Table::prepare_items()
- WP_Widget_Recent_Comments::widget()Outputs the content for the current Recent Comments widget instance.
- get_comment_count()Retrieves the total comment counts for the whole site or a single post.
- post_comment_meta_box()Displays comments for post.
- render_block_core_latest_comments()Renders the `core/latest-comments` block on server.
- twentynineteen_get_discussion_data()Returns information about the current post's discussion, with cache support.
- wp_comments_personal_data_eraser()Erases personal data associated with an email address from the comments table.
- wp_comments_personal_data_exporter()Finds and exports personal data associated with an email address from the comments table.
Show all 15
- wp_dashboard_recent_comments()Show Comments section.
- wp_list_comments()Displays a list of comments.
- wp_xmlrpc_server::wp_getComments()Retrieves comments.
Source code
function get_comments( $args = '' ) { $query = new WP_Comment_Query(); return $query->query( $args );}Changelog
Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 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.