WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

comments_open()

comments_open( int|WP_Post $post = null ): bool

In this article

Back to top

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

$postint|WP_Postoptional
Post ID or WP_Post object. Default current post.

Default:null

Return

bool True if the comments are open.

Source

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

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘comments_open’, bool $comments_open, int $post_id )

Filters whether the current post is open for comments.

UsesDescription
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Used byDescription
register_and_do_post_meta_boxes()wp-admin/includes/meta-boxes.php

Registers the default post meta boxes, and runs the do_meta_boxes actions.

WP_REST_Comments_Controller::create_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Checks if a given request has access to create a comment.

print_embed_comments_button()wp-includes/embed.php

Prints the necessary markup for the embed comments button.

wp_handle_comment_submission()wp-includes/comment.php

Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.

feed_links_extra()wp-includes/general-template.php

Displays the links to the extra feeds such as category feeds.

wp_xmlrpc_server::wp_newComment()wp-includes/class-wp-xmlrpc-server.php

Creates a new comment.

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

Prepares page data for return in an XML-RPC object.

get_post_reply_link()wp-includes/comment-template.php

Retrieves HTML content for reply to post link.

comment_form()wp-includes/comment-template.php

Outputs a complete commenting form for use within a template.

comments_popup_link()wp-includes/comment-template.php

Displays the link to the comments for the current post ID.

get_comment_reply_link()wp-includes/comment-template.php

Retrieves HTML content for reply to comment link.

Show 6 moreShow less

Changelog

VersionDescription
1.5.0Introduced.

User Contributed Notes

  1. Skip to note 5 content
    Codex
    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

    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 6 content
    Codex
    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

    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 );
  4. Skip to note 8 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: -3You must log in to vote on the helpfulness of this note

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

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