wp_revisions_to_keep

Determine how many revisions to retain for a given post.

Description

(int) wp_revisions_to_keep( (WP_Post) $post ); 

By default, an infinite number of revisions are kept.

The constant WP_POST_REVISIONS can be set in wp-config to specify the limit of revisions to keep.

Returns (int)

The number of revisions to keep.

Parameters (1)

0. $post (WP_Post)
The post object.

Usage

  1. if ( !function_exists( 'wp_revisions_to_keep' ) ) { 
  2.     require_once ABSPATH . WPINC . '/revision.php'; 
  3. } 
  4.   
  5. // The post object. 
  6. $post = null; 
  7.   
  8. // NOTICE! Understand what this does before running. 
  9. $result = wp_revisions_to_keep($post); 
  10.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/revision.php  
  1. function wp_revisions_to_keep( $post ) { 
  3.  
  4.     if ( true === $num ) 
  5.         $num = -1; 
  6.     else 
  7.         $num = intval( $num ); 
  8.  
  9.     if ( ! post_type_supports( $post->post_type, 'revisions' ) ) 
  10.         $num = 0; 
  11.  
  12.     /** 
  13.      * Filters the number of revisions to save for the given post. 
  14.      * 
  15.      * Overrides the value of WP_POST_REVISIONS. 
  16.      * 
  17.      * @since 3.6.0 
  18.      * 
  19.      * @param int     $num  Number of revisions to store. 
  20.      * @param WP_Post $post Post object. 
  21.      */ 
  22.     return (int) apply_filters( 'wp_revisions_to_keep', $num, $post ); 
  23. }