3
* Post revision functions.
6
* @subpackage Post_Revisions
10
* Determines which fields of posts are to be saved in revisions.
12
* Does two things. If passed a post *array*, it will return a post array ready
13
* to be inserted into the posts table as a post revision. Otherwise, returns
14
* an array whose keys are the post fields to be saved for post revisions.
19
* @param array $post Optional a post array to be processed for insertion as a post revision.
20
* @param bool $autosave optional Is the revision an autosave?
21
* @return array Post array ready to be inserted as a post revision or array of fields that can be versioned.
23
function _wp_post_revision_fields( $post = null, $autosave = false ) {
24
static $fields = false;
27
// Allow these to be versioned
29
'post_title' => __( 'Title' ),
30
'post_content' => __( 'Content' ),
31
'post_excerpt' => __( 'Excerpt' ),
35
* Filter the list of fields saved in post revisions.
37
* Included by default: 'post_title', 'post_content' and 'post_excerpt'.
39
* Disallowed fields: 'ID', 'post_name', 'post_parent', 'post_date',
40
* 'post_date_gmt', 'post_status', 'post_type', 'comment_count',
45
* @param array $fields List of fields to revision. Contains 'post_title',
46
* 'post_content', and 'post_excerpt' by default.
48
$fields = apply_filters( '_wp_post_revision_fields', $fields );
50
// WP uses these internally either in versioning or elsewhere - they cannot be versioned
51
foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect )
52
unset( $fields[$protect] );
55
if ( !is_array($post) )
59
foreach ( array_intersect( array_keys( $post ), array_keys( $fields ) ) as $field )
60
$return[$field] = $post[$field];
62
$return['post_parent'] = $post['ID'];
63
$return['post_status'] = 'inherit';
64
$return['post_type'] = 'revision';
65
$return['post_name'] = $autosave ? "$post[ID]-autosave-v1" : "$post[ID]-revision-v1"; // "1" is the revisioning system version
66
$return['post_date'] = isset($post['post_modified']) ? $post['post_modified'] : '';
67
$return['post_date_gmt'] = isset($post['post_modified_gmt']) ? $post['post_modified_gmt'] : '';
73
* Saves an already existing post as a post revision.
75
* Typically used immediately after post updates.
76
* Adds a copy of the current post as a revision, so latest revision always matches current post
80
* @uses _wp_put_post_revision()
82
* @param int $post_id The ID of the post to save as a revision.
83
* @return mixed Null or 0 if error, new revision ID, if success.
85
function wp_save_post_revision( $post_id ) {
86
if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
89
if ( ! $post = get_post( $post_id ) )
92
if ( ! post_type_supports( $post->post_type, 'revisions' ) )
95
if ( 'auto-draft' == $post->post_status )
98
if ( ! wp_revisions_enabled( $post ) )
101
// Compare the proposed update with the last stored revision verifying that
102
// they are different, unless a plugin tells us to always save regardless.
103
// If no previous revisions, save one
104
if ( $revisions = wp_get_post_revisions( $post_id ) ) {
105
// grab the last revision, but not an autosave
106
foreach ( $revisions as $revision ) {
107
if ( false !== strpos( $revision->post_name, "{$revision->post_parent}-revision" ) ) {
108
$last_revision = $revision;
114
* Filter whether the post has changed since the last revision.
116
* By default a revision is saved only if one of the revisioned fields has changed.
117
* This filter can override that so a revision is saved even if nothing has changed.
121
* @param bool $check_for_changes Whether to check for changes before saving a new revision.
123
* @param int $last_revision ID of the last revision.
124
* @param int $post Post ID.
127
if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', $check_for_changes = true, $last_revision, $post ) ) {
128
$post_has_changed = false;
130
foreach ( array_keys( _wp_post_revision_fields() ) as $field ) {
131
if ( normalize_whitespace( $post->$field ) != normalize_whitespace( $last_revision->$field ) ) {
132
$post_has_changed = true;
136
//don't save revision if post unchanged
137
if( ! $post_has_changed )
142
$return = _wp_put_post_revision( $post );
144
$revisions_to_keep = wp_revisions_to_keep( $post );
146
if ( $revisions_to_keep < 0 )
149
// all revisions and autosaves
150
$revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
152
$delete = count($revisions) - $revisions_to_keep;
157
$revisions = array_slice( $revisions, 0, $delete );
159
for ( $i = 0; isset( $revisions[$i] ); $i++ ) {
160
if ( false !== strpos( $revisions[ $i ]->post_name, 'autosave' ) )
163
wp_delete_post_revision( $revisions[ $i ]->ID );
170
* Retrieve the autosaved data of the specified post.
172
* Returns a post object containing the information that was autosaved for the
173
* specified post. If the optional $user_id is passed, returns the autosave for that user
174
* otherwise returns the latest autosave.
178
* @uses wp_get_post_revisions()
180
* @param int $post_id The post ID.
181
* @param int $user_id optional The post author ID.
182
* @return object|bool The autosaved data or false on failure or when no autosave exists.
184
function wp_get_post_autosave( $post_id, $user_id = 0 ) {
185
$revisions = wp_get_post_revisions( $post_id, array( 'check_enabled' => false ) );
187
foreach ( $revisions as $revision ) {
188
if ( false !== strpos( $revision->post_name, "{$post_id}-autosave" ) ) {
189
if ( $user_id && $user_id != $revision->post_author )
200
* Determines if the specified post is a revision.
204
* @param int|object $post Post ID or post object.
205
* @return bool|int False if not a revision, ID of revision's parent otherwise.
207
function wp_is_post_revision( $post ) {
208
if ( !$post = wp_get_post_revision( $post ) )
211
return (int) $post->post_parent;
215
* Determines if the specified post is an autosave.
219
* @param int|object $post Post ID or post object.
220
* @return bool|int False if not a revision, ID of autosave's parent otherwise
222
function wp_is_post_autosave( $post ) {
223
if ( !$post = wp_get_post_revision( $post ) )
226
if ( false !== strpos( $post->post_name, "{$post->post_parent}-autosave" ) )
227
return (int) $post->post_parent;
233
* Inserts post data into the posts table as a post revision.
238
* @uses wp_insert_post()
240
* @param int|object|array $post Post ID, post object OR post array.
241
* @param bool $autosave Optional. Is the revision an autosave?
242
* @return mixed WP_Error or 0 if error, new revision ID if success.
244
function _wp_put_post_revision( $post = null, $autosave = false ) {
245
if ( is_object($post) )
246
$post = get_object_vars( $post );
247
elseif ( !is_array($post) )
248
$post = get_post($post, ARRAY_A);
250
if ( ! $post || empty($post['ID']) )
251
return new WP_Error( 'invalid_post', __( 'Invalid post ID' ) );
253
if ( isset($post['post_type']) && 'revision' == $post['post_type'] )
254
return new WP_Error( 'post_type', __( 'Cannot create a revision of a revision' ) );
256
$post = _wp_post_revision_fields( $post, $autosave );
257
$post = wp_slash($post); //since data is from db
259
$revision_id = wp_insert_post( $post );
260
if ( is_wp_error($revision_id) )
263
if ( $revision_id ) {
265
* Fires once a revision has been saved.
269
* @param int $revision_id Post revision ID.
271
do_action( '_wp_put_post_revision', $revision_id );
278
* Gets a post revision.
284
* @param int|object $post The post ID or object.
285
* @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
286
* @param string $filter Optional sanitation filter. @see sanitize_post().
287
* @return mixed Null if error or post object if success.
289
function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
290
if ( !$revision = get_post( $post, OBJECT, $filter ) )
292
if ( 'revision' !== $revision->post_type )
295
if ( $output == OBJECT ) {
297
} elseif ( $output == ARRAY_A ) {
298
$_revision = get_object_vars($revision);
300
} elseif ( $output == ARRAY_N ) {
301
$_revision = array_values(get_object_vars($revision));
309
* Restores a post to the specified revision.
311
* Can restore a past revision using all fields of the post revision, or only selected fields.
315
* @uses wp_get_post_revision()
316
* @uses wp_update_post()
318
* @param int|object $revision_id Revision ID or revision object.
319
* @param array $fields Optional. What fields to restore from. Defaults to all.
320
* @return mixed Null if error, false if no fields to restore, (int) post ID if success.
322
function wp_restore_post_revision( $revision_id, $fields = null ) {
323
if ( !$revision = wp_get_post_revision( $revision_id, ARRAY_A ) )
326
if ( !is_array( $fields ) )
327
$fields = array_keys( _wp_post_revision_fields() );
330
foreach( array_intersect( array_keys( $revision ), $fields ) as $field ) {
331
$update[$field] = $revision[$field];
337
$update['ID'] = $revision['post_parent'];
339
$update = wp_slash( $update ); //since data is from db
341
$post_id = wp_update_post( $update );
342
if ( ! $post_id || is_wp_error( $post_id ) )
345
// Add restore from details
346
$restore_details = array(
347
'restored_revision_id' => $revision_id,
348
'restored_by_user' => get_current_user_id(),
349
'restored_time' => time()
351
update_post_meta( $post_id, '_post_restored_from', $restore_details );
353
// Update last edit user
354
update_post_meta( $post_id, '_edit_last', get_current_user_id() );
357
* Fires after a post revision has been restored.
361
* @param int $post_id Post ID.
362
* @param int $revision_id Post revision ID.
364
do_action( 'wp_restore_post_revision', $post_id, $revision['ID'] );
370
* Deletes a revision.
372
* Deletes the row from the posts table corresponding to the specified revision.
376
* @uses wp_get_post_revision()
377
* @uses wp_delete_post()
379
* @param int|object $revision_id Revision ID or revision object.
380
* @return mixed Null or WP_Error if error, deleted post if success.
382
function wp_delete_post_revision( $revision_id ) {
383
if ( !$revision = wp_get_post_revision( $revision_id ) )
386
$delete = wp_delete_post( $revision->ID );
387
if ( is_wp_error( $delete ) )
392
* Fires once a post revision has been deleted.
396
* @param int $revision_id Post revision ID.
397
* @param object|array $revision Post revision object or array.
399
do_action( 'wp_delete_post_revision', $revision->ID, $revision );
406
* Returns all revisions of specified post.
410
* @uses get_children()
412
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
413
* @return array An array of revisions, or an empty array if none.
415
function wp_get_post_revisions( $post_id = 0, $args = null ) {
416
$post = get_post( $post_id );
417
if ( ! $post || empty( $post->ID ) )
420
$defaults = array( 'order' => 'DESC', 'orderby' => 'date ID', 'check_enabled' => true );
421
$args = wp_parse_args( $args, $defaults );
423
if ( $args['check_enabled'] && ! wp_revisions_enabled( $post ) )
426
$args = array_merge( $args, array( 'post_parent' => $post->ID, 'post_type' => 'revision', 'post_status' => 'inherit' ) );
428
if ( ! $revisions = get_children( $args ) )
435
* Determine if revisions are enabled for a given post.
439
* @uses wp_revisions_to_keep()
441
* @param object $post The post object.
442
* @return bool True if number of revisions to keep isn't zero, false otherwise.
444
function wp_revisions_enabled( $post ) {
445
return wp_revisions_to_keep( $post ) != 0;
449
* Determine how many revisions to retain for a given post.
450
* By default, an infinite number of revisions are stored if a post type supports revisions.
454
* @uses post_type_supports()
456
* @param object $post The post object.
457
* @return int The number of revisions to keep.
459
function wp_revisions_to_keep( $post ) {
460
$num = WP_POST_REVISIONS;
465
$num = intval( $num );
467
if ( ! post_type_supports( $post->post_type, 'revisions' ) )
471
* Filter the number of revisions to save for the given post.
473
* Overrides the value of WP_POST_REVISIONS.
477
* @param int $num Number of revisions to store.
478
* @param WP_Post $post Post object.
480
return (int) apply_filters( 'wp_revisions_to_keep', $num, $post );
484
* Sets up the post object for preview based on the post autosave.
489
function _set_preview($post) {
491
if ( ! is_object($post) )
494
$preview = wp_get_post_autosave($post->ID);
496
if ( ! is_object($preview) )
499
$preview = sanitize_post($preview);
501
$post->post_content = $preview->post_content;
502
$post->post_title = $preview->post_title;
503
$post->post_excerpt = $preview->post_excerpt;
505
add_filter( 'get_the_terms', '_wp_preview_terms_filter', 10, 3 );
511
* Filters the latest content for preview from the post autosave.
516
function _show_post_preview() {
518
if ( isset($_GET['preview_id']) && isset($_GET['preview_nonce']) ) {
519
$id = (int) $_GET['preview_id'];
521
if ( false == wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . $id ) )
522
wp_die( __('You do not have permission to preview drafts.') );
524
add_filter('the_preview', '_set_preview');
529
* Filters terms lookup to set the post format.
534
function _wp_preview_terms_filter( $terms, $post_id, $taxonomy ) {
535
if ( ! $post = get_post() )
538
if ( empty( $_REQUEST['post_format'] ) || $post->ID != $post_id || 'post_format' != $taxonomy || 'revision' == $post->post_type )
541
if ( 'standard' == $_REQUEST['post_format'] )
543
elseif ( $term = get_term_by( 'slug', 'post-format-' . sanitize_key( $_REQUEST['post_format'] ), 'post_format' ) )
544
$terms = array( $term ); // Can only have one post format
550
* Gets the post revision version.
555
function _wp_get_post_revision_version( $revision ) {
556
if ( is_object( $revision ) )
557
$revision = get_object_vars( $revision );
558
elseif ( !is_array( $revision ) )
561
if ( preg_match( '/^\d+-(?:autosave|revision)-v(\d+)$/', $revision['post_name'], $matches ) )
562
return (int) $matches[1];
568
* Upgrade the revisions author, add the current post as a revision and set the revisions version to 1
573
* @uses wp_get_post_revisions()
575
* @param object $post Post object
576
* @param array $revisions Current revisions of the post
577
* @return bool true if the revisions were upgraded, false if problems
579
function _wp_upgrade_revisions_of_post( $post, $revisions ) {
582
// Add post option exclusively
583
$lock = "revision-upgrade-{$post->ID}";
585
$result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, 'no') /* LOCK */", $lock, $now ) );
587
// If we couldn't get a lock, see how old the previous lock is
588
$locked = get_option( $lock );
590
// Can't write to the lock, and can't read the lock.
591
// Something broken has happened
595
if ( $locked > $now - 3600 ) {
596
// Lock is not too old: some other process may be upgrading this post. Bail.
600
// Lock is too old - update it (below) and continue
603
// If we could get a lock, re-"add" the option to fire all the correct filters.
604
update_option( $lock, $now );
610
$this_revision = current( $revisions );
611
$prev_revision = next( $revisions );
613
$this_revision_version = _wp_get_post_revision_version( $this_revision );
615
// Something terrible happened
616
if ( false === $this_revision_version )
619
// 1 is the latest revision version, so we're already up to date.
620
// No need to add a copy of the post as latest revision.
621
if ( 0 < $this_revision_version ) {
626
// Always update the revision version
628
'post_name' => preg_replace( '/^(\d+-(?:autosave|revision))[\d-]*$/', '$1-v1', $this_revision->post_name ),
631
// If this revision is the oldest revision of the post, i.e. no $prev_revision,
632
// the correct post_author is probably $post->post_author, but that's only a good guess.
633
// Update the revision version only and Leave the author as-is.
634
if ( $prev_revision ) {
635
$prev_revision_version = _wp_get_post_revision_version( $prev_revision );
637
// If the previous revision is already up to date, it no longer has the information we need :(
638
if ( $prev_revision_version < 1 )
639
$update['post_author'] = $prev_revision->post_author;
642
// Upgrade this revision
643
$result = $wpdb->update( $wpdb->posts, $update, array( 'ID' => $this_revision->ID ) );
646
wp_cache_delete( $this_revision->ID, 'posts' );
648
} while ( $prev_revision );
650
delete_option( $lock );
652
// Add a copy of the post as latest revision.
654
wp_save_post_revision( $post->ID );
added
removed
wp-includes/revision.php
