/**
* Determines which fields of posts are to be saved in revisions.
*
- * Does two things. If passed a post *array*, it will return a post array ready
- * to be inserted into the posts table as a post revision. Otherwise, returns
- * an array whose keys are the post fields to be saved for post revisions.
- *
* @since 2.6.0
+ * @since 4.5.0 A `WP_Post` object can now be passed to the `$post` parameter.
+ * @since 4.5.0 The optional `$autosave` parameter was deprecated and renamed to `$deprecated`.
* @access private
*
* @staticvar array $fields
*
- * @param array|null $post Optional. A post array to be processed for insertion as a post revision. Default null.
- * @param bool $autosave Optional. Is the revision an autosave? Default false.
- * @return array Post array ready to be inserted as a post revision or array of fields that can be versioned.
+ * @param array|WP_Post $post Optional. A post array or a WP_Post object being processed
+ * for insertion as a post revision. Default empty array.
+ * @param bool $deprecated Not used.
+ * @return array Array of fields that can be versioned.
*/
-function _wp_post_revision_fields( $post = null, $autosave = false ) {
+function _wp_post_revision_fields( $post = array(), $deprecated = false ) {
static $fields = null;
+ if ( ! is_array( $post ) ) {
+ $post = get_post( $post, ARRAY_A );
+ }
+
if ( is_null( $fields ) ) {
// Allow these to be versioned
$fields = array(
'post_content' => __( 'Content' ),
'post_excerpt' => __( 'Excerpt' ),
);
+ }
- /**
- * Filter the list of fields saved in post revisions.
- *
- * Included by default: 'post_title', 'post_content' and 'post_excerpt'.
- *
- * Disallowed fields: 'ID', 'post_name', 'post_parent', 'post_date',
- * 'post_date_gmt', 'post_status', 'post_type', 'comment_count',
- * and 'post_author'.
- *
- * @since 2.6.0
- *
- * @param array $fields List of fields to revision. Contains 'post_title',
- * 'post_content', and 'post_excerpt' by default.
- */
- $fields = apply_filters( '_wp_post_revision_fields', $fields );
+ /**
+ * Filter the list of fields saved in post revisions.
+ *
+ * Included by default: 'post_title', 'post_content' and 'post_excerpt'.
+ *
+ * Disallowed fields: 'ID', 'post_name', 'post_parent', 'post_date',
+ * 'post_date_gmt', 'post_status', 'post_type', 'comment_count',
+ * and 'post_author'.
+ *
+ * @since 2.6.0
+ * @since 4.5.0 The `$post` parameter was added.
+ *
+ * @param array $fields List of fields to revision. Contains 'post_title',
+ * 'post_content', and 'post_excerpt' by default.
+ * @param array $post A post array being processed for insertion as a post revision.
+ */
+ $fields = apply_filters( '_wp_post_revision_fields', $fields, $post );
+
+ // WP uses these internally either in versioning or elsewhere - they cannot be versioned
+ foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect ) {
+ unset( $fields[ $protect ] );
+ }
- // WP uses these internally either in versioning or elsewhere - they cannot be versioned
- foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect )
- unset( $fields[$protect] );
+
+ return $fields;
+}
+
+/**
+ * Returns a post array ready to be inserted into the posts table as a post revision.
+ *
+ * @since 4.5.0
+ * @access private
+ *
+ * @param array|WP_Post $post Optional. A post array or a WP_Post object to be processed
+ * for insertion as a post revision. Default empty array.
+ * @param bool $autosave Optional. Is the revision an autosave? Default false.
+ * @return array Post array ready to be inserted as a post revision.
+ */
+function _wp_post_revision_data( $post = array(), $autosave = false ) {
+ if ( ! is_array( $post ) ) {
+ $post = get_post( $post, ARRAY_A );
}
- if ( !is_array($post) )
- return $fields;
+ $fields = _wp_post_revision_fields( $post );
- $return = array();
- foreach ( array_intersect( array_keys( $post ), array_keys( $fields ) ) as $field )
- $return[$field] = $post[$field];
+ $revision_data = array();
- $return['post_parent'] = $post['ID'];
- $return['post_status'] = 'inherit';
- $return['post_type'] = 'revision';
- $return['post_name'] = $autosave ? "$post[ID]-autosave-v1" : "$post[ID]-revision-v1"; // "1" is the revisioning system version
- $return['post_date'] = isset($post['post_modified']) ? $post['post_modified'] : '';
- $return['post_date_gmt'] = isset($post['post_modified_gmt']) ? $post['post_modified_gmt'] : '';
+ foreach ( array_intersect( array_keys( $post ), array_keys( $fields ) ) as $field ) {
+ $revision_data[ $field ] = $post[ $field ];
+ }
- return $return;
+ $revision_data['post_parent'] = $post['ID'];
+ $revision_data['post_status'] = 'inherit';
+ $revision_data['post_type'] = 'revision';
+ $revision_data['post_name'] = $autosave ? "$post[ID]-autosave-v1" : "$post[ID]-revision-v1"; // "1" is the revisioning system version
+ $revision_data['post_date'] = isset( $post['post_modified'] ) ? $post['post_modified'] : '';
+ $revision_data['post_date_gmt'] = isset( $post['post_modified_gmt'] ) ? $post['post_modified_gmt'] : '';
+
+ return $revision_data;
}
/**
*
* @param bool $check_for_changes Whether to check for changes before saving a new revision.
* Default true.
- * @param WP_Post $last_revision The the last revision post object.
+ * @param WP_Post $last_revision The last revision post object.
* @param WP_Post $post The post object.
*
*/
if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', $check_for_changes = true, $last_revision, $post ) ) {
$post_has_changed = false;
- foreach ( array_keys( _wp_post_revision_fields() ) as $field ) {
+ foreach ( array_keys( _wp_post_revision_fields( $post ) ) as $field ) {
if ( normalize_whitespace( $post->$field ) != normalize_whitespace( $last_revision->$field ) ) {
$post_has_changed = true;
break;
if ( isset($post['post_type']) && 'revision' == $post['post_type'] )
return new WP_Error( 'post_type', __( 'Cannot create a revision of a revision' ) );
- $post = _wp_post_revision_fields( $post, $autosave );
+ $post = _wp_post_revision_data( $post, $autosave );
$post = wp_slash($post); //since data is from db
$revision_id = wp_insert_post( $post );
return $revision;
if ( !is_array( $fields ) )
- $fields = array_keys( _wp_post_revision_fields() );
+ $fields = array_keys( _wp_post_revision_fields( $revision ) );
$update = array();
foreach ( array_intersect( array_keys( $revision ), $fields ) as $field ) {
*
* @since 2.6.0
*
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
+ * @see get_children()
+ *
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @param array|null $args Optional. Arguments for retrieving post revisions. Default null.
* @return array An array of revisions, or an empty array if none.
*/
function wp_get_post_revisions( $post_id = 0, $args = null ) {