W3cubDocs

/WordPress

comments_open( int|WP_Post $post_id = null )

Determines whether the current post is open for comments.

Description

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Parameters

$post_id

(int|WP_Post) (Optional) Post ID or WP_Post object. Default current post.

Default value: null

Return

(bool) True if the comments are open.

Source

File: wp-includes/comment-template.php 

function comments_open( $post_id = null ) {

	$_post = get_post( $post_id );

	$post_id = $_post ? $_post->ID : 0;
	$open    = ( 'open' === $_post->comment_status );

	/**
	 * Filters whether the current post is open for comments.
	 *
	 * @since 2.5.0
	 *
	 * @param bool $open    Whether the current post is open for comments.
	 * @param int  $post_id The post ID.
	 */
	return apply_filters( 'comments_open', $open, $post_id );
}

Uses

Uses Description
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/comment-template.php: comments_open

Filters whether the current post is open for comments.

Used By

Used By Description
wp-admin/includes/meta-boxes.php: register_and_do_post_meta_boxes()

Registers the default post meta boxes, and runs the do_meta_boxes actions.
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php: WP_REST_Comments_Controller::create_item_permissions_check()

Checks if a given request has access to create a comment.
wp-includes/embed.php: print_embed_comments_button()

Prints the necessary markup for the embed comments button.
wp-includes/comment.php: wp_handle_comment_submission()

Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
wp-includes/general-template.php: feed_links_extra()

Display the links to the extra feeds such as category feeds.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_newComment()

Create new comment.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_page()

Prepares page data for return in an XML-RPC object.
wp-includes/comment-template.php: get_post_reply_link()

Retrieves HTML content for reply to post link.
wp-includes/comment-template.php: comment_form()

Outputs a complete commenting form for use within a template.
wp-includes/comment-template.php: comments_popup_link()

Displays the link to the comments for the current post ID.
wp-includes/comment-template.php: get_comment_reply_link()

Retrieves HTML content for reply to comment link.

Changelog

Version Description
1.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/comments_open