[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> revision.php (source)

   1  <?php
   2  /**
   3   * Post revision functions.
   4   *
   5   * @package WordPress
   6   * @subpackage Post_Revisions
   7   */
   8  
   9  /**
  10   * Determines which fields of posts are to be saved in revisions.
  11   *
  12   * @since 2.6.0
  13   * @since 4.5.0 A `WP_Post` object can now be passed to the `$post` parameter.
  14   * @since 4.5.0 The optional `$autosave` parameter was deprecated and renamed to `$deprecated`.
  15   * @access private
  16   *
  17   * @param array|WP_Post $post       Optional. A post array or a WP_Post object being processed
  18   *                                  for insertion as a post revision. Default empty array.
  19   * @param bool          $deprecated Not used.
  20   * @return array Array of fields that can be versioned.
  21   */
  22  function _wp_post_revision_fields( $post = array(), $deprecated = false ) {
  23      static $fields = null;
  24  
  25      if ( ! is_array( $post ) ) {
  26          $post = get_post( $post, ARRAY_A );
  27      }
  28  
  29      if ( is_null( $fields ) ) {
  30          // Allow these to be versioned.
  31          $fields = array(
  32              'post_title'   => __( 'Title' ),
  33              'post_content' => __( 'Content' ),
  34              'post_excerpt' => __( 'Excerpt' ),
  35          );
  36      }
  37  
  38      /**
  39       * Filters the list of fields saved in post revisions.
  40       *
  41       * Included by default: 'post_title', 'post_content' and 'post_excerpt'.
  42       *
  43       * Disallowed fields: 'ID', 'post_name', 'post_parent', 'post_date',
  44       * 'post_date_gmt', 'post_status', 'post_type', 'comment_count',
  45       * and 'post_author'.
  46       *
  47       * @since 2.6.0
  48       * @since 4.5.0 The `$post` parameter was added.
  49       *
  50       * @param array $fields List of fields to revision. Contains 'post_title',
  51       *                      'post_content', and 'post_excerpt' by default.
  52       * @param array $post   A post array being processed for insertion as a post revision.
  53       */
  54      $fields = apply_filters( '_wp_post_revision_fields', $fields, $post );
  55  
  56      // WP uses these internally either in versioning or elsewhere - they cannot be versioned.
  57      foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect ) {
  58          unset( $fields[ $protect ] );
  59      }
  60  
  61      return $fields;
  62  }
  63  
  64  /**
  65   * Returns a post array ready to be inserted into the posts table as a post revision.
  66   *
  67   * @since 4.5.0
  68   * @access private
  69   *
  70   * @param array|WP_Post $post     Optional. A post array or a WP_Post object to be processed
  71   *                                for insertion as a post revision. Default empty array.
  72   * @param bool          $autosave Optional. Is the revision an autosave? Default false.
  73   * @return array Post array ready to be inserted as a post revision.
  74   */
  75  function _wp_post_revision_data( $post = array(), $autosave = false ) {
  76      if ( ! is_array( $post ) ) {
  77          $post = get_post( $post, ARRAY_A );
  78      }
  79  
  80      $fields = _wp_post_revision_fields( $post );
  81  
  82      $revision_data = array();
  83  
  84      foreach ( array_intersect( array_keys( $post ), array_keys( $fields ) ) as $field ) {
  85          $revision_data[ $field ] = $post[ $field ];
  86      }
  87  
  88      $revision_data['post_parent']   = $post['ID'];
  89      $revision_data['post_status']   = 'inherit';
  90      $revision_data['post_type']     = 'revision';
  91      $revision_data['post_name']     = $autosave ? "$post[ID]-autosave-v1" : "$post[ID]-revision-v1"; // "1" is the revisioning system version.
  92      $revision_data['post_date']     = isset( $post['post_modified'] ) ? $post['post_modified'] : '';
  93      $revision_data['post_date_gmt'] = isset( $post['post_modified_gmt'] ) ? $post['post_modified_gmt'] : '';
  94  
  95      return $revision_data;
  96  }
  97  
  98  /**
  99   * Creates a revision for the current version of a post.
 100   *
 101   * Typically used immediately after a post update, as every update is a revision,
 102   * and the most recent revision always matches the current post.
 103   *
 104   * @since 2.6.0
 105   *
 106   * @param int $post_id The ID of the post to save as a revision.
 107   * @return int|WP_Error|void Void or 0 if error, new revision ID, if success.
 108   */
 109  function wp_save_post_revision( $post_id ) {
 110      if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
 111          return;
 112      }
 113  
 114      $post = get_post( $post_id );
 115      if ( ! $post ) {
 116          return;
 117      }
 118  
 119      if ( ! post_type_supports( $post->post_type, 'revisions' ) ) {
 120          return;
 121      }
 122  
 123      if ( 'auto-draft' === $post->post_status ) {
 124          return;
 125      }
 126  
 127      if ( ! wp_revisions_enabled( $post ) ) {
 128          return;
 129      }
 130  
 131      /*
 132       * Compare the proposed update with the last stored revision verifying that
 133       * they are different, unless a plugin tells us to always save regardless.
 134       * If no previous revisions, save one.
 135       */
 136      $revisions = wp_get_post_revisions( $post_id );
 137      if ( $revisions ) {
 138          // Grab the last revision, but not an autosave.
 139          foreach ( $revisions as $revision ) {
 140              if ( false !== strpos( $revision->post_name, "{$revision->post_parent}-revision" ) ) {
 141                  $last_revision = $revision;
 142                  break;
 143              }
 144          }
 145  
 146          /**
 147           * Filters whether the post has changed since the last revision.
 148           *
 149           * By default a revision is saved only if one of the revisioned fields has changed.
 150           * This filter can override that so a revision is saved even if nothing has changed.
 151           *
 152           * @since 3.6.0
 153           *
 154           * @param bool    $check_for_changes Whether to check for changes before saving a new revision.
 155           *                                   Default true.
 156           * @param WP_Post $last_revision     The last revision post object.
 157           * @param WP_Post $post              The post object.
 158           */
 159          if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', true, $last_revision, $post ) ) {
 160              $post_has_changed = false;
 161  
 162              foreach ( array_keys( _wp_post_revision_fields( $post ) ) as $field ) {
 163                  if ( normalize_whitespace( $post->$field ) !== normalize_whitespace( $last_revision->$field ) ) {
 164                      $post_has_changed = true;
 165                      break;
 166                  }
 167              }
 168  
 169              /**
 170               * Filters whether a post has changed.
 171               *
 172               * By default a revision is saved only if one of the revisioned fields has changed.
 173               * This filter allows for additional checks to determine if there were changes.
 174               *
 175               * @since 4.1.0
 176               *
 177               * @param bool    $post_has_changed Whether the post has changed.
 178               * @param WP_Post $last_revision    The last revision post object.
 179               * @param WP_Post $post             The post object.
 180               */
 181              $post_has_changed = (bool) apply_filters( 'wp_save_post_revision_post_has_changed', $post_has_changed, $last_revision, $post );
 182  
 183              // Don't save revision if post unchanged.
 184              if ( ! $post_has_changed ) {
 185                  return;
 186              }
 187          }
 188      }
 189  
 190      $return = _wp_put_post_revision( $post );
 191  
 192      // If a limit for the number of revisions to keep has been set,
 193      // delete the oldest ones.
 194      $revisions_to_keep = wp_revisions_to_keep( $post );
 195  
 196      if ( $revisions_to_keep < 0 ) {
 197          return $return;
 198      }
 199  
 200      $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
 201  
 202      $delete = count( $revisions ) - $revisions_to_keep;
 203  
 204      if ( $delete < 1 ) {
 205          return $return;
 206      }
 207  
 208      $revisions = array_slice( $revisions, 0, $delete );
 209  
 210      for ( $i = 0; isset( $revisions[ $i ] ); $i++ ) {
 211          if ( false !== strpos( $revisions[ $i ]->post_name, 'autosave' ) ) {
 212              continue;
 213          }
 214  
 215          wp_delete_post_revision( $revisions[ $i ]->ID );
 216      }
 217  
 218      return $return;
 219  }
 220  
 221  /**
 222   * Retrieve the autosaved data of the specified post.
 223   *
 224   * Returns a post object with the information that was autosaved for the specified post.
 225   * If the optional $user_id is passed, returns the autosave for that user, otherwise
 226   * returns the latest autosave.
 227   *
 228   * @since 2.6.0
 229   *
 230   * @param int $post_id The post ID.
 231   * @param int $user_id Optional The post author ID.
 232   * @return WP_Post|false The autosaved data or false on failure or when no autosave exists.
 233   */
 234  function wp_get_post_autosave( $post_id, $user_id = 0 ) {
 235      global $wpdb;
 236  
 237      $autosave_name = $post_id . '-autosave-v1';
 238      $user_id_query = ( 0 !== $user_id ) ? "AND post_author = $user_id" : null;
 239  
 240      // Construct the autosave query.
 241      $autosave_query = "
 242          SELECT *
 243          FROM $wpdb->posts
 244          WHERE post_parent = %d
 245          AND post_type = 'revision'
 246          AND post_status = 'inherit'
 247          AND post_name   = %s " . $user_id_query . '
 248          ORDER BY post_date DESC
 249          LIMIT 1';
 250  
 251      $autosave = $wpdb->get_results(
 252          $wpdb->prepare(
 253              $autosave_query,
 254              $post_id,
 255              $autosave_name
 256          )
 257      );
 258  
 259      if ( ! $autosave ) {
 260          return false;
 261      }
 262  
 263      return get_post( $autosave[0] );
 264  }
 265  
 266  /**
 267   * Determines if the specified post is a revision.
 268   *
 269   * @since 2.6.0
 270   *
 271   * @param int|WP_Post $post Post ID or post object.
 272   * @return int|false ID of revision's parent on success, false if not a revision.
 273   */
 274  function wp_is_post_revision( $post ) {
 275      $post = wp_get_post_revision( $post );
 276      if ( ! $post ) {
 277          return false;
 278      }
 279  
 280      return (int) $post->post_parent;
 281  }
 282  
 283  /**
 284   * Determines if the specified post is an autosave.
 285   *
 286   * @since 2.6.0
 287   *
 288   * @param int|WP_Post $post Post ID or post object.
 289   * @return int|false ID of autosave's parent on success, false if not a revision.
 290   */
 291  function wp_is_post_autosave( $post ) {
 292      $post = wp_get_post_revision( $post );
 293      if ( ! $post ) {
 294          return false;
 295      }
 296  
 297      if ( false !== strpos( $post->post_name, "{$post->post_parent}-autosave" ) ) {
 298          return (int) $post->post_parent;
 299      }
 300  
 301      return false;
 302  }
 303  
 304  /**
 305   * Inserts post data into the posts table as a post revision.
 306   *
 307   * @since 2.6.0
 308   * @access private
 309   *
 310   * @param int|WP_Post|array|null $post     Post ID, post object OR post array.
 311   * @param bool                   $autosave Optional. Is the revision an autosave?
 312   * @return int|WP_Error WP_Error or 0 if error, new revision ID if success.
 313   */
 314  function _wp_put_post_revision( $post = null, $autosave = false ) {
 315      if ( is_object( $post ) ) {
 316          $post = get_object_vars( $post );
 317      } elseif ( ! is_array( $post ) ) {
 318          $post = get_post( $post, ARRAY_A );
 319      }
 320  
 321      if ( ! $post || empty( $post['ID'] ) ) {
 322          return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) );
 323      }
 324  
 325      if ( isset( $post['post_type'] ) && 'revision' === $post['post_type'] ) {
 326          return new WP_Error( 'post_type', __( 'Cannot create a revision of a revision' ) );
 327      }
 328  
 329      $post = _wp_post_revision_data( $post, $autosave );
 330      $post = wp_slash( $post ); // Since data is from DB.
 331  
 332      $revision_id = wp_insert_post( $post );
 333      if ( is_wp_error( $revision_id ) ) {
 334          return $revision_id;
 335      }
 336  
 337      if ( $revision_id ) {
 338          /**
 339           * Fires once a revision has been saved.
 340           *
 341           * @since 2.6.0
 342           *
 343           * @param int $revision_id Post revision ID.
 344           */
 345          do_action( '_wp_put_post_revision', $revision_id );
 346      }
 347  
 348      return $revision_id;
 349  }
 350  
 351  /**
 352   * Gets a post revision.
 353   *
 354   * @since 2.6.0
 355   *
 356   * @param int|WP_Post $post   The post ID or object.
 357   * @param string      $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
 358   *                            a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT.
 359   * @param string      $filter Optional sanitation filter. See sanitize_post().
 360   * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
 361   */
 362  function wp_get_post_revision( &$post, $output = OBJECT, $filter = 'raw' ) {
 363      $revision = get_post( $post, OBJECT, $filter );
 364      if ( ! $revision ) {
 365          return $revision;
 366      }
 367      if ( 'revision' !== $revision->post_type ) {
 368          return null;
 369      }
 370  
 371      if ( OBJECT == $output ) {
 372          return $revision;
 373      } elseif ( ARRAY_A == $output ) {
 374          $_revision = get_object_vars( $revision );
 375          return $_revision;
 376      } elseif ( ARRAY_N == $output ) {
 377          $_revision = array_values( get_object_vars( $revision ) );
 378          return $_revision;
 379      }
 380  
 381      return $revision;
 382  }
 383  
 384  /**
 385   * Restores a post to the specified revision.
 386   *
 387   * Can restore a past revision using all fields of the post revision, or only selected fields.
 388   *
 389   * @since 2.6.0
 390   *
 391   * @param int|WP_Post $revision_id Revision ID or revision object.
 392   * @param array       $fields      Optional. What fields to restore from. Defaults to all.
 393   * @return int|false|null Null if error, false if no fields to restore, (int) post ID if success.
 394   */
 395  function wp_restore_post_revision( $revision_id, $fields = null ) {
 396      $revision = wp_get_post_revision( $revision_id, ARRAY_A );
 397      if ( ! $revision ) {
 398          return $revision;
 399      }
 400  
 401      if ( ! is_array( $fields ) ) {
 402          $fields = array_keys( _wp_post_revision_fields( $revision ) );
 403      }
 404  
 405      $update = array();
 406      foreach ( array_intersect( array_keys( $revision ), $fields ) as $field ) {
 407          $update[ $field ] = $revision[ $field ];
 408      }
 409  
 410      if ( ! $update ) {
 411          return false;
 412      }
 413  
 414      $update['ID'] = $revision['post_parent'];
 415  
 416      $update = wp_slash( $update ); // Since data is from DB.
 417  
 418      $post_id = wp_update_post( $update );
 419      if ( ! $post_id || is_wp_error( $post_id ) ) {
 420          return $post_id;
 421      }
 422  
 423      // Update last edit user.
 424      update_post_meta( $post_id, '_edit_last', get_current_user_id() );
 425  
 426      /**
 427       * Fires after a post revision has been restored.
 428       *
 429       * @since 2.6.0
 430       *
 431       * @param int $post_id     Post ID.
 432       * @param int $revision_id Post revision ID.
 433       */
 434      do_action( 'wp_restore_post_revision', $post_id, $revision['ID'] );
 435  
 436      return $post_id;
 437  }
 438  
 439  /**
 440   * Deletes a revision.
 441   *
 442   * Deletes the row from the posts table corresponding to the specified revision.
 443   *
 444   * @since 2.6.0
 445   *
 446   * @param int|WP_Post $revision_id Revision ID or revision object.
 447   * @return array|false|WP_Post|WP_Error|null Null or WP_Error if error, deleted post if success.
 448   */
 449  function wp_delete_post_revision( $revision_id ) {
 450      $revision = wp_get_post_revision( $revision_id );
 451      if ( ! $revision ) {
 452          return $revision;
 453      }
 454  
 455      $delete = wp_delete_post( $revision->ID );
 456      if ( $delete ) {
 457          /**
 458           * Fires once a post revision has been deleted.
 459           *
 460           * @since 2.6.0
 461           *
 462           * @param int     $revision_id Post revision ID.
 463           * @param WP_Post $revision    Post revision object.
 464           */
 465          do_action( 'wp_delete_post_revision', $revision->ID, $revision );
 466      }
 467  
 468      return $delete;
 469  }
 470  
 471  /**
 472   * Returns all revisions of specified post.
 473   *
 474   * @since 2.6.0
 475   *
 476   * @see get_children()
 477   *
 478   * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global `$post`.
 479   * @param array|null  $args    Optional. Arguments for retrieving post revisions. Default null.
 480   * @return array An array of revisions, or an empty array if none.
 481   */
 482  function wp_get_post_revisions( $post_id = 0, $args = null ) {
 483      $post = get_post( $post_id );
 484      if ( ! $post || empty( $post->ID ) ) {
 485          return array();
 486      }
 487  
 488      $defaults = array(
 489          'order'         => 'DESC',
 490          'orderby'       => 'date ID',
 491          'check_enabled' => true,
 492      );
 493      $args     = wp_parse_args( $args, $defaults );
 494  
 495      if ( $args['check_enabled'] && ! wp_revisions_enabled( $post ) ) {
 496          return array();
 497      }
 498  
 499      $args = array_merge(
 500          $args,
 501          array(
 502              'post_parent' => $post->ID,
 503              'post_type'   => 'revision',
 504              'post_status' => 'inherit',
 505          )
 506      );
 507  
 508      $revisions = get_children( $args );
 509      if ( ! $revisions ) {
 510          return array();
 511      }
 512  
 513      return $revisions;
 514  }
 515  
 516  /**
 517   * Determine if revisions are enabled for a given post.
 518   *
 519   * @since 3.6.0
 520   *
 521   * @param WP_Post $post The post object.
 522   * @return bool True if number of revisions to keep isn't zero, false otherwise.
 523   */
 524  function wp_revisions_enabled( $post ) {
 525      return wp_revisions_to_keep( $post ) !== 0;
 526  }
 527  
 528  /**
 529   * Determine how many revisions to retain for a given post.
 530   *
 531   * By default, an infinite number of revisions are kept.
 532   *
 533   * The constant WP_POST_REVISIONS can be set in wp-config to specify the limit
 534   * of revisions to keep.
 535   *
 536   * @since 3.6.0
 537   *
 538   * @param WP_Post $post The post object.
 539   * @return int The number of revisions to keep.
 540   */
 541  function wp_revisions_to_keep( $post ) {
 542      $num = WP_POST_REVISIONS;
 543  
 544      if ( true === $num ) {
 545          $num = -1;
 546      } else {
 547          $num = intval( $num );
 548      }
 549  
 550      if ( ! post_type_supports( $post->post_type, 'revisions' ) ) {
 551          $num = 0;
 552      }
 553  
 554      /**
 555       * Filters the number of revisions to save for the given post.
 556       *
 557       * Overrides the value of WP_POST_REVISIONS.
 558       *
 559       * @since 3.6.0
 560       *
 561       * @param int     $num  Number of revisions to store.
 562       * @param WP_Post $post Post object.
 563       */
 564      return (int) apply_filters( 'wp_revisions_to_keep', $num, $post );
 565  }
 566  
 567  /**
 568   * Sets up the post object for preview based on the post autosave.
 569   *
 570   * @since 2.7.0
 571   * @access private
 572   *
 573   * @param WP_Post $post
 574   * @return WP_Post|false
 575   */
 576  function _set_preview( $post ) {
 577      if ( ! is_object( $post ) ) {
 578          return $post;
 579      }
 580  
 581      $preview = wp_get_post_autosave( $post->ID );
 582      if ( ! is_object( $preview ) ) {
 583          return $post;
 584      }
 585  
 586      $preview = sanitize_post( $preview );
 587  
 588      $post->post_content = $preview->post_content;
 589      $post->post_title   = $preview->post_title;
 590      $post->post_excerpt = $preview->post_excerpt;
 591  
 592      add_filter( 'get_the_terms', '_wp_preview_terms_filter', 10, 3 );
 593      add_filter( 'get_post_metadata', '_wp_preview_post_thumbnail_filter', 10, 3 );
 594  
 595      return $post;
 596  }
 597  
 598  /**
 599   * Filters the latest content for preview from the post autosave.
 600   *
 601   * @since 2.7.0
 602   * @access private
 603   */
 604  function _show_post_preview() {
 605      if ( isset( $_GET['preview_id'] ) && isset( $_GET['preview_nonce'] ) ) {
 606          $id = (int) $_GET['preview_id'];
 607  
 608          if ( false === wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . $id ) ) {
 609              wp_die( __( 'Sorry, you are not allowed to preview drafts.' ), 403 );
 610          }
 611  
 612          add_filter( 'the_preview', '_set_preview' );
 613      }
 614  }
 615  
 616  /**
 617   * Filters terms lookup to set the post format.
 618   *
 619   * @since 3.6.0
 620   * @access private
 621   *
 622   * @param array  $terms
 623   * @param int    $post_id
 624   * @param string $taxonomy
 625   * @return array
 626   */
 627  function _wp_preview_terms_filter( $terms, $post_id, $taxonomy ) {
 628      $post = get_post();
 629      if ( ! $post ) {
 630          return $terms;
 631      }
 632  
 633      if ( empty( $_REQUEST['post_format'] ) || $post->ID != $post_id
 634          || 'post_format' !== $taxonomy || 'revision' === $post->post_type
 635      ) {
 636          return $terms;
 637      }
 638  
 639      if ( 'standard' === $_REQUEST['post_format'] ) {
 640          $terms = array();
 641      } else {
 642          $term = get_term_by( 'slug', 'post-format-' . sanitize_key( $_REQUEST['post_format'] ), 'post_format' );
 643          if ( $term ) {
 644              $terms = array( $term ); // Can only have one post format.
 645          }
 646      }
 647  
 648      return $terms;
 649  }
 650  
 651  /**
 652   * Filters post thumbnail lookup to set the post thumbnail.
 653   *
 654   * @since 4.6.0
 655   * @access private
 656   *
 657   * @param null|array|string $value    The value to return - a single metadata value, or an array of values.
 658   * @param int               $post_id  Post ID.
 659   * @param string            $meta_key Meta key.
 660   * @return null|array The default return value or the post thumbnail meta array.
 661   */
 662  function _wp_preview_post_thumbnail_filter( $value, $post_id, $meta_key ) {
 663      $post = get_post();
 664      if ( ! $post ) {
 665          return $value;
 666      }
 667  
 668      if ( empty( $_REQUEST['_thumbnail_id'] ) ||
 669          empty( $_REQUEST['preview_id'] ) ||
 670          $post->ID != $post_id ||
 671          '_thumbnail_id' !== $meta_key ||
 672          'revision' === $post->post_type ||
 673          $post_id != $_REQUEST['preview_id'] ) {
 674  
 675          return $value;
 676      }
 677  
 678      $thumbnail_id = intval( $_REQUEST['_thumbnail_id'] );
 679      if ( $thumbnail_id <= 0 ) {
 680          return '';
 681      }
 682  
 683      return strval( $thumbnail_id );
 684  }
 685  
 686  /**
 687   * Gets the post revision version.
 688   *
 689   * @since 3.6.0
 690   * @access private
 691   *
 692   * @param WP_Post $revision
 693   * @return int|false
 694   */
 695  function _wp_get_post_revision_version( $revision ) {
 696      if ( is_object( $revision ) ) {
 697          $revision = get_object_vars( $revision );
 698      } elseif ( ! is_array( $revision ) ) {
 699          return false;
 700      }
 701  
 702      if ( preg_match( '/^\d+-(?:autosave|revision)-v(\d+)$/', $revision['post_name'], $matches ) ) {
 703          return (int) $matches[1];
 704      }
 705  
 706      return 0;
 707  }
 708  
 709  /**
 710   * Upgrade the revisions author, add the current post as a revision and set the revisions version to 1
 711   *
 712   * @since 3.6.0
 713   * @access private
 714   *
 715   * @global wpdb $wpdb WordPress database abstraction object.
 716   *
 717   * @param WP_Post $post      Post object
 718   * @param array   $revisions Current revisions of the post
 719   * @return bool true if the revisions were upgraded, false if problems
 720   */
 721  function _wp_upgrade_revisions_of_post( $post, $revisions ) {
 722      global $wpdb;
 723  
 724      // Add post option exclusively.
 725      $lock   = "revision-upgrade-{$post->ID}";
 726      $now    = time();
 727      $result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, 'no') /* LOCK */", $lock, $now ) );
 728      if ( ! $result ) {
 729          // If we couldn't get a lock, see how old the previous lock is.
 730          $locked = get_option( $lock );
 731          if ( ! $locked ) {
 732              // Can't write to the lock, and can't read the lock.
 733              // Something broken has happened.
 734              return false;
 735          }
 736  
 737          if ( $locked > $now - 3600 ) {
 738              // Lock is not too old: some other process may be upgrading this post. Bail.
 739              return false;
 740          }
 741  
 742          // Lock is too old - update it (below) and continue.
 743      }
 744  
 745      // If we could get a lock, re-"add" the option to fire all the correct filters.
 746      update_option( $lock, $now );
 747  
 748      reset( $revisions );
 749      $add_last = true;
 750  
 751      do {
 752          $this_revision = current( $revisions );
 753          $prev_revision = next( $revisions );
 754  
 755          $this_revision_version = _wp_get_post_revision_version( $this_revision );
 756  
 757          // Something terrible happened.
 758          if ( false === $this_revision_version ) {
 759              continue;
 760          }
 761  
 762          // 1 is the latest revision version, so we're already up to date.
 763          // No need to add a copy of the post as latest revision.
 764          if ( 0 < $this_revision_version ) {
 765              $add_last = false;
 766              continue;
 767          }
 768  
 769          // Always update the revision version.
 770          $update = array(
 771              'post_name' => preg_replace( '/^(\d+-(?:autosave|revision))[\d-]*$/', '$1-v1', $this_revision->post_name ),
 772          );
 773  
 774          /*
 775           * If this revision is the oldest revision of the post, i.e. no $prev_revision,
 776           * the correct post_author is probably $post->post_author, but that's only a good guess.
 777           * Update the revision version only and Leave the author as-is.
 778           */
 779          if ( $prev_revision ) {
 780              $prev_revision_version = _wp_get_post_revision_version( $prev_revision );
 781  
 782              // If the previous revision is already up to date, it no longer has the information we need :(
 783              if ( $prev_revision_version < 1 ) {
 784                  $update['post_author'] = $prev_revision->post_author;
 785              }
 786          }
 787  
 788          // Upgrade this revision.
 789          $result = $wpdb->update( $wpdb->posts, $update, array( 'ID' => $this_revision->ID ) );
 790  
 791          if ( $result ) {
 792              wp_cache_delete( $this_revision->ID, 'posts' );
 793          }
 794      } while ( $prev_revision );
 795  
 796      delete_option( $lock );
 797  
 798      // Add a copy of the post as latest revision.
 799      if ( $add_last ) {
 800          wp_save_post_revision( $post->ID );
 801      }
 802  
 803      return true;
 804  }


Generated : Thu Jul 16 08:20:02 2020 Cross-referenced by PHPXref