comments_open( int|WP_Post $post_id = null )

Determines whether the current post is open for comments.

Contents

Description Description

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

Parameters Parameters

$post_id

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

Default value: null

Top ↑

Return Return

(bool) True if the comments are open.

Top ↑

Source 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 );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

Top ↑

Uses Uses

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

Call the functions 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.

Top ↑

Used By Used By

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()

Retrieve 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()

Retrieve HTML content for reply to comment link.
Show 6 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Enqueuing a script only if we’re seeing a single post and comments are open for the current post

    /**
 * Enqueue wpdocs_script if viewing a post with comments enabled.
 */
function wpdocs_scripts(){
	if ( is_single() && comments_open() ) {
		// wpdocs_script must have been previously registered via wp_register_script()
		wp_enqueue_script( 'wpdocs_script' );
	}
}
add_action( 'wp_print_scripts', 'wpdocs_scripts' );
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    With this code you can always disable comments on pages, assuming your theme uses comments_open() to check if the comments are open.
    Note: Comments are disabled on pages by default in 4.3+.

    /**
 * Disable comments on pages.
 *
 * @param bool $open    Whether comments should be open.
 * @param int  $post_id Post ID.
 * @return bool Whether comments should be open.
 */
function wpdocs_comments_open( $open, $post_id ) {
	$post = get_post( $post_id );
	if ( 'page' == $post->post_type )
		$open = false;
	return $open;
}
add_filter( 'comments_open', 'wpdocs_comments_open', 10, 2 );

    Expand full source codeCollapse full source code

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    With this code you can enable comments on a post that has custom field “Allow Comments” set to 1.

    This is helpful when you have told WordPress to disable comments for posts that are older than X days but wish to enable comments for a handful of old posts.

    /**
 * Enable or disable comments based on custom field Allow Comments.
 *
 * @param bool $open    Whether comments should be open.
 * @param int  $post_id Post ID.
 * @return bool Whether comments should be open.
 */
function wpdocs_comments_open( $open, $post_id ) {
	$post = get_post( $post_id );
        if (get_post_meta($post->ID, 'Allow Comments', true)) {
		$open = true;
	}
	return $open;
}
add_filter( 'comments_open', 'wpdocs_comments_open', 10, 2 );

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.