comments_open() WordPress Function

The comments_open() function allows you to determine whether comments are open for a post or not. This can be useful for conditionally hiding or showing comment form fields. By default, the function will check the post type and status of the post to see if comments are open.

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.


Top ↑

Parameters

$post_id

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

Default value: null


Top ↑

Return

(bool) True if the comments are open.


Top ↑

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    = ( $_post && ( '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 );
}


Top ↑

Changelog

Changelog
VersionDescription
1.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More