_wp_post_revision_fields

Determines which fields of posts are to be saved in revisions.

Description

(array) _wp_post_revision_fields( (array) $post = array(), (bool) $deprecated = false ); 

Returns (array)

Array of fields that can be versioned.

Parameters (2)

0. $post — Optional. (array) => array()
A post array or a WP_Post object being processed for insertion as a post revision. Default empty array.
1. $deprecated — Optional. (bool) => false
The deprecated.

Usage

  1. if ( !function_exists( '_wp_post_revision_fields' ) ) { 
  2.     require_once ABSPATH . WPINC . '/revision.php'; 
  3. } 
  4.   
  5. // Optional. A post array or a WP_Post object being processed 
  6. // for insertion as a post revision. Default empty array. 
  7. $post = array(); 
  8.   
  9. // The deprecated. 
  10. $deprecated = false; 
  11.   
  12. // NOTICE! Understand what this does before running. 
  13. $result = _wp_post_revision_fields($post, $deprecated); 
  14.     

Defined (1)

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

/wp-includes/revision.php  
  1. function _wp_post_revision_fields( $post = array(), $deprecated = false ) { 
  2.     static $fields = null; 
  3.  
  4.     if ( ! is_array( $post ) ) { 
  5.         $post = get_post( $post, ARRAY_A ); 
  6.     } 
  7.  
  8.     if ( is_null( $fields ) ) { 
  9.         // Allow these to be versioned 
  10.         $fields = array( 
  11.             'post_title' => __( 'Title' ),  
  12.             'post_content' => __( 'Content' ),  
  13.             'post_excerpt' => __( 'Excerpt' ),  
  14.  ); 
  15.     } 
  16.  
  17.     /** 
  18.      * Filters the list of fields saved in post revisions. 
  19.      * 
  20.      * Included by default: 'post_title', 'post_content' and 'post_excerpt'. 
  21.      * 
  22.      * Disallowed fields: 'ID', 'post_name', 'post_parent', 'post_date',  
  23.      * 'post_date_gmt', 'post_status', 'post_type', 'comment_count',  
  24.      * and 'post_author'. 
  25.      * 
  26.      * @since 2.6.0 
  27.      * @since 4.5.0 The `$post` parameter was added. 
  28.      * 
  29.      * @param array $fields List of fields to revision. Contains 'post_title',  
  30.      *                      'post_content', and 'post_excerpt' by default. 
  31.      * @param array $post   A post array being processed for insertion as a post revision. 
  32.      */ 
  33.     $fields = apply_filters( '_wp_post_revision_fields', $fields, $post ); 
  34.  
  35.     // WP uses these internally either in versioning or elsewhere - they cannot be versioned 
  36.     foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect ) { 
  37.         unset( $fields[ $protect ] ); 
  38.     } 
  39.  
  40.  
  41.     return $fields; 
  42. }