wppaste
WordPress

_close_comments_for_old_posts( WP_Post $posts, WP_Query $query ): array

Since
2.7.0
Source
wp-includes/comment.php:3437
Closes comments on old posts on the fly, without any extra DB queries. Hooked to the_posts.

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

$postsWP_Post
Post data object.
$queryWP_Query
Query object.

Return value

array

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling
Constant

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

Instructions
5–45

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

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
  • hookthird-party callbacksapply_filters()called directly
  • cacheobject cachewp_cache_get()one call below _close_comments_for_old_posts()
  • serializeserialisationmaybe_unserialize()one call below _close_comments_for_old_posts()

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

What one call costs · 6 distinct outcomes

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

WhenInstructionsCalls it makes
empty($posts)5none
!empty($posts) && !->is_singular()8->is_singular()
!empty($posts) && ->is_singular() && !get_option()12->is_singular(), get_option()
!empty($posts) && ->is_singular() && get_option() && !$post_types22->is_singular(), get_option(), apply_filters()
!empty($posts) && ->is_singular() && get_option() && $post_types27->is_singular(), get_option(), apply_filters(), get_option()
!empty($posts) && ->is_singular() && get_option() && $post_types39–45->is_singular(), get_option(), apply_filters(), get_option(), time(), strtotime()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev485–456
8.5485–456
8.4485–4563 fewer instructions than PHP 8.3
8.3515–486
8.2515–486
8.1515–486
7.4515–486

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

  1. apply_filters( close_comments_for_post_types )filterline 3449 (+12 into the body)

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

Uses · 2

  • get_option()Retrieves an option value based on an option name.
  • apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

function _close_comments_for_old_posts( $posts, $query ) {	if ( empty( $posts ) || ! $query->is_singular() || ! get_option( 'close_comments_for_old_posts' ) ) {		return $posts;	} 	/**	 * Filters the list of post types to automatically close comments for.	 *	 * @since 3.2.0	 *	 * @param string[] $post_types An array of post type names.	 */	$post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );	if ( ! in_array( $posts[0]->post_type, $post_types, true ) ) {		return $posts;	} 	$days_old = (int) get_option( 'close_comments_days_old' );	if ( ! $days_old ) {		return $posts;	} 	if ( time() - strtotime( $posts[0]->post_date_gmt ) > ( $days_old * DAY_IN_SECONDS ) ) {		$posts[0]->comment_status = 'closed';		$posts[0]->ping_status    = 'closed';	} 	return $posts;}

Changelog

Introduced in 2.7.0. 2 changes between 6.7.7 and 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.

6.9.7
Parameter $posts retyped from WP_Post to WP_Post[].verified against source
6.9.7
Return type changed from array to WP_Post[].verified against source
2.7.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 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.