wppaste
WordPress

_close_comments_for_old_post( bool $open, int $post_id ): bool

Since
2.7.0
Source
wp-includes/comment.php:3540
Closes comments on an old post. Hooked to comments_open and pings_open.

Compatibility

WordPress
since 2.7.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

$openbool
Comments open or closed.
$post_idint
Post ID.

Return value

bool
$open

Performance profile

How much work a call to _close_comments_for_old_post() 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

Reaches the database via get_post().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
4–40

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 46.

Plugin surface
1 hook

Third-party callbacks on 'close_comments_for_post_types' run inside this call, and their cost is not bounded by anything here.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • optionoption read or writeget_option()called directly
  • querycontent queryget_post()called directly
  • hookthird-party callbacksapply_filters()called directly
  • cacheobject cachewp_cache_get()one call below _close_comments_for_old_post()
  • serializeserialisationmaybe_unserialize()one call below _close_comments_for_old_post()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 5 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _close_comments_for_old_post() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always4none
!get_option()8get_option()
get_option()13get_option(), get_option()
get_option()26–29get_option(), get_option(), get_post(), apply_filters()
get_option() && $post_types40get_option(), get_option(), get_post(), apply_filters(), time(), strtotime()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev464–406
8.5464–406
8.4464–4063 fewer instructions than PHP 8.3
8.3494–436
8.2494–436
8.1494–436
7.4494–436

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 _close_comments_for_old_post() runs, in this order:

  1. apply_filters( close_comments_for_post_types )filterline 3557 (+17 into the body)

    Filters the list of post types to automatically close comments for.

Uses · 3

  • get_option()Retrieves an option value based on an option name.
  • 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.

Source code

function _close_comments_for_old_post( $open, $post_id ) {	if ( ! $open ) {		return $open;	} 	if ( ! get_option( 'close_comments_for_old_posts' ) ) {		return $open;	} 	$days_old = (int) get_option( 'close_comments_days_old' );	if ( ! $days_old ) {		return $open;	} 	$post = get_post( $post_id ); 	/** This filter is documented in wp-includes/comment.php */	$post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );	if ( ! in_array( $post->post_type, $post_types, true ) ) {		return $open;	} 	// Undated drafts should not show up as comments closed.	if ( '0000-00-00 00:00:00' === $post->post_date_gmt ) {		return $open;	} 	if ( time() - strtotime( $post->post_date_gmt ) > ( $days_old * DAY_IN_SECONDS ) ) {		return false;	} 	return $open;}

Changelog

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 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.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.