wp_revisions_to_keep( WP_Post $post ): int

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$postWP_Post

The post object.

Return value

int

The number of revisions to keep.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

31–32

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

Plugin surface

2 hooks

Third-party callbacks on 'wp_revisions_to_keep', 'wp_{$post->post_type}_revisions_to_keep' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

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

Hooks and filters fired · 2

2 hooks fire while wp_revisions_to_keep() runs, in this order:

1. 1
   apply_filters( wp_revisions_to_keep )filterline 821 (+23 into the body)

   Filters the number of revisions to save for the given post.

2. 2
   apply_filters( wp_{$post->post_type}_revisions_to_keep )filterline 841 (+43 into the body)

   Filters the number of revisions to save for the given post by its post type.

Uses · 2

• post_type_supports()Checks a post type's support for a given feature.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• wp_revisions_enabled()Determines whether revisions are enabled for a given post.
• wp_save_post_revision()Creates a revision for the current version of a post.

Source code

View on Trac ↗View on GitHub ↗

798function wp_revisions_to_keep( $post ) {799	$num = WP_POST_REVISIONS;800 801	if ( true === $num ) {802		$num = -1;803	} else {804		$num = (int) $num;805	}806 807	if ( ! post_type_supports( $post->post_type, 'revisions' ) ) {808		$num = 0;809	}810 811	/**812	 * Filters the number of revisions to save for the given post.813	 *814	 * Overrides the value of WP_POST_REVISIONS.815	 *816	 * @since 3.6.0817	 *818	 * @param int     $num  Number of revisions to store.819	 * @param WP_Post $post Post object.820	 */821	$num = apply_filters( 'wp_revisions_to_keep', $num, $post );822 823	/**824	 * Filters the number of revisions to save for the given post by its post type.825	 *826	 * Overrides both the value of WP_POST_REVISIONS and the {@see 'wp_revisions_to_keep'} filter.827	 *828	 * The dynamic portion of the hook name, `$post->post_type`, refers to829	 * the post type slug.830	 *831	 * Possible hook names include:832	 *833	 *  - `wp_post_revisions_to_keep`834	 *  - `wp_page_revisions_to_keep`835	 *836	 * @since 5.8.0837	 *838	 * @param int     $num  Number of revisions to store.839	 * @param WP_Post $post Post object.840	 */841	$num = apply_filters( "wp_{$post->post_type}_revisions_to_keep", $num, $post );842 843	return (int) $num;844}

Changelog

Introduced in 3.6.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 7.0.4 tag, from src/wp-includes/revision.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.