comments_open( int|WP_Post $post = null ): bool
- Since
- 1.5.0
- Source
wp-includes/comment-template.php:1311
Description
For more information on this and similar theme functions, check out the https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags article in the Theme Developer Handbook.
Compatibility
- WordPress
- since 1.5.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
$postint|WP_Postoptional- Post ID or WP_Post object. Default current post.Default:
null
Return value
bool- True if the comments are open.
Performance profile
How much work a call to comments_open() 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
- Scaling
- Constant
- Instructions
- 16–19
- Plugin surface
- 1 hook
- Called by
- 28
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 20.
Third-party callbacks on 'comments_open' run inside this call, and their cost is not bounded by anything here.
28 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, 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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost comments_open() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 16–19 | get_post(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 20 | 16–19 | 2 | |
| 8.5 | 20 | 16–19 | 2 | |
| 8.4 | 20 | 16–19 | 2 | |
| 8.3 | 20 | 16–19 | 2 | |
| 8.2 | 20 | 16–19 | 2 | |
| 8.1 | 20 | 16–19 | 2 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 21 | 16–20 | 2 |
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.
Hooks and filters fired · 1
One hook fires while comments_open() runs, in this order:
- apply_filters( comments_open )filterline 1325 (+14 into the body)
Filters whether the current post is open for comments.
Uses · 2
- get_post()Retrieves post data given a post ID or post object.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 28
- Twenty_Fourteen_Ephemera_Widget::widget()Outputs the HTML for this widget.
- WP_REST_Comments_Controller::create_item_permissions_check()Checks if a given request has access to create a comment.
- comment_form()Outputs a complete commenting form for use within a template.
- comments_popup_link()Displays the link to the comments for the current post ID.
- feed_links_extra()Displays the links to the extra feeds such as category feeds.
- get_comment_reply_link()Retrieves HTML content for reply to comment link.
- get_post_reply_link()Retrieves HTML content for reply to post link.
- print_embed_comments_button()Prints the necessary markup for the embed comments button.
- register_and_do_post_meta_boxes()Registers the default post meta boxes, and runs the `do_meta_boxes` actions.
- render_block_core_comments()Renders the `core/comments` block on the server.
- render_block_core_post_comments_link()Renders the `core/post-comments-link` block on the server.
- twenty_twenty_one_scripts()Enqueues scripts and styles.
Show all 28
- twentyfifteen_entry_meta()Prints HTML with meta information for the categories, tags.
- twentyfifteen_scripts()Enqueues scripts and styles.
- twentyfourteen_scripts()Enqueues scripts and styles for the front end.
- twentynineteen_comment_count()Prints HTML with the comment count for the current post.
- twentynineteen_scripts()Enqueues scripts and styles.
- twentyseventeen_scripts()Enqueues scripts and styles.
- twentysixteen_entry_meta()Prints HTML with meta information for the categories, tags.
- twentysixteen_scripts()Enqueues scripts and styles.
- twentythirteen_scripts_styles()Enqueues scripts and styles for the front end.
- twentytwelve_scripts_styles()Enqueues scripts and styles for front end.
- twentytwenty_body_classes()Adds conditional body classes.
- twentytwenty_get_post_meta()Retrieves the post meta.
- twentytwenty_register_scripts()Registers and Enqueues Scripts.
- wp_handle_comment_submission()Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
- wp_xmlrpc_server::_prepare_page()Prepares page data for return in an XML-RPC object.
- wp_xmlrpc_server::wp_newComment()Creates a new comment.
Source code
function comments_open( $post = null ) { $_post = get_post( $post ); $post_id = $_post ? $_post->ID : 0; $comments_open = ( $_post && ( 'open' === $_post->comment_status ) ); /** * Filters whether the current post is open for comments. * * @since 2.5.0 * * @param bool $comments_open Whether the current post is open for comments. * @param int $post_id The post ID. */ return apply_filters( 'comments_open', $comments_open, $post_id );}Changelog
Introduced in 1.5.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.9.7 tag, from
src/wp-includes/comment-template.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.