3 * WordPress Administration Revisions API
6 * @subpackage Administration
10 * Get the revision UI diff.
14 * @param object|int $post The post object. Also accepts a post ID.
15 * @param int $compare_from The revision ID to compare from.
16 * @param int $compare_to The revision ID to come to.
18 * @return array|bool Associative array of a post's revisioned fields and their diffs.
19 * Or, false on failure.
21 function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
22 if ( ! $post = get_post( $post ) )
25 if ( $compare_from ) {
26 if ( ! $compare_from = get_post( $compare_from ) )
29 // If we're dealing with the first revision...
30 $compare_from = false;
33 if ( ! $compare_to = get_post( $compare_to ) )
36 // If comparing revisions, make sure we're dealing with the right post parent.
37 // The parent post may be a 'revision' when revisions are disabled and we're looking at autosaves.
38 if ( $compare_from && $compare_from->post_parent !== $post->ID && $compare_from->ID !== $post->ID )
40 if ( $compare_to->post_parent !== $post->ID && $compare_to->ID !== $post->ID )
43 if ( $compare_from && strtotime( $compare_from->post_date_gmt ) > strtotime( $compare_to->post_date_gmt ) ) {
44 $temp = $compare_from;
45 $compare_from = $compare_to;
49 // Add default title if title field is empty
50 if ( $compare_from && empty( $compare_from->post_title ) )
51 $compare_from->post_title = __( '(no title)' );
52 if ( empty( $compare_to->post_title ) )
53 $compare_to->post_title = __( '(no title)' );
57 foreach ( _wp_post_revision_fields() as $field => $name ) {
59 * Contextually filter a post revision field.
61 * The dynamic portion of the hook name, $field, corresponds to each of the post
62 * fields of the revision object being iterated over in a foreach statement.
66 * @param string $compare_from->$field The current revision field to compare to or from.
67 * @param string $field The current revision field.
68 * @param WP_Post $compare_from The revision post object to compare to or from.
69 * @param string null The context of whether the current revision is the old or the new one. Values are 'to' or 'from'.
71 $content_from = $compare_from ? apply_filters( "_wp_post_revision_field_$field", $compare_from->$field, $field, $compare_from, 'from' ) : '';
73 /** This filter is documented in wp-admin/includes/revision.php */
74 $content_to = apply_filters( "_wp_post_revision_field_$field", $compare_to->$field, $field, $compare_to, 'to' );
76 $diff = wp_text_diff( $content_from, $content_to, array( 'show_split_view' => true ) );
78 if ( ! $diff && 'post_title' === $field ) {
79 // It's a better user experience to still show the Title, even if it didn't change.
80 // No, you didn't see this.
81 $diff = '<table class="diff"><colgroup><col class="content diffsplit left"><col class="content diffsplit middle"><col class="content diffsplit right"></colgroup><tbody><tr>';
82 $diff .= '<td>' . esc_html( $compare_from->post_title ) . '</td><td></td><td>' . esc_html( $compare_to->post_title ) . '</td>';
83 $diff .= '</tr></tbody>';
99 * Prepare revisions for JavaScript.
103 * @param object|int $post The post object. Also accepts a post ID.
104 * @param int $selected_revision_id The selected revision ID.
105 * @param int $from Optional. The revision ID to compare from.
107 * @return array An associative array of revision data and related settings.
109 function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null ) {
110 $post = get_post( $post );
111 $revisions = $authors = array();
114 $revisions = wp_get_post_revisions( $post->ID, array( 'order' => 'ASC', 'check_enabled' => false ) );
115 // If revisions are disabled, we only want autosaves and the current post.
116 if ( ! wp_revisions_enabled( $post ) ) {
117 foreach ( $revisions as $revision_id => $revision ) {
118 if ( ! wp_is_post_autosave( $revision ) )
119 unset( $revisions[ $revision_id ] );
121 $revisions = array( $post->ID => $post ) + $revisions;
124 $show_avatars = get_option( 'show_avatars' );
126 cache_users( wp_list_pluck( $revisions, 'post_author' ) );
128 $can_restore = current_user_can( 'edit_post', $post->ID );
130 foreach ( $revisions as $revision ) {
131 $modified = strtotime( $revision->post_modified );
132 $modified_gmt = strtotime( $revision->post_modified_gmt );
133 if ( $can_restore ) {
134 $restore_link = str_replace( '&', '&', wp_nonce_url(
136 array( 'revision' => $revision->ID,
137 'action' => 'restore' ),
138 admin_url( 'revision.php' )
140 "restore-post_{$revision->ID}"
144 if ( ! isset( $authors[ $revision->post_author ] ) ) {
145 $authors[ $revision->post_author ] = array(
146 'id' => (int) $revision->post_author,
147 'avatar' => $show_avatars ? get_avatar( $revision->post_author, 32 ) : '',
148 'name' => get_the_author_meta( 'display_name', $revision->post_author ),
152 $autosave = (bool) wp_is_post_autosave( $revision );
153 $current = ! $autosave && $revision->post_modified_gmt === $post->post_modified_gmt;
154 if ( $current && ! empty( $current_id ) ) {
155 // If multiple revisions have the same post_modified_gmt, highest ID is current.
156 if ( $current_id < $revision->ID ) {
157 $revisions[ $current_id ]['current'] = false;
158 $current_id = $revision->ID;
162 } elseif ( $current ) {
163 $current_id = $revision->ID;
166 $revisions[ $revision->ID ] = array(
167 'id' => $revision->ID,
168 'title' => get_the_title( $post->ID ),
169 'author' => $authors[ $revision->post_author ],
170 'date' => date_i18n( __( 'M j, Y @ G:i' ), $modified ),
171 'dateShort' => date_i18n( _x( 'j M @ G:i', 'revision date short format' ), $modified ),
172 'timeAgo' => sprintf( __( '%s ago' ), human_time_diff( $modified_gmt, $now_gmt ) ),
173 'autosave' => $autosave,
174 'current' => $current,
175 'restoreUrl' => $can_restore ? $restore_link : false,
179 // If a post has been saved since the last revision (no revisioned fields were changed)
180 // we may not have a "current" revision. Mark the latest revision as "current".
181 if ( empty( $current_id ) ) {
182 if ( $revisions[ $revision->ID ]['autosave'] ) {
183 $revision = end( $revisions );
184 while ( $revision['autosave'] ) {
185 $revision = prev( $revisions );
187 $current_id = $revision['id'];
189 $current_id = $revision->ID;
191 $revisions[ $current_id ]['current'] = true;
194 // Now, grab the initial diff
195 $compare_two_mode = is_numeric( $from );
196 if ( ! $compare_two_mode ) {
197 $found = array_search( $selected_revision_id, array_keys( $revisions ) );
199 $from = array_keys( array_slice( $revisions, $found - 1, 1, true ) );
200 $from = reset( $from );
206 $from = absint( $from );
208 $diffs = array( array(
209 'id' => $from . ':' . $selected_revision_id,
210 'fields' => wp_get_revision_ui_diff( $post->ID, $from, $selected_revision_id ),
214 'postId' => $post->ID,
215 'nonce' => wp_create_nonce( 'revisions-ajax-nonce' ),
216 'revisionData' => array_values( $revisions ),
217 'to' => $selected_revision_id,
219 'diffData' => $diffs,
220 'baseUrl' => parse_url( admin_url( 'revision.php' ), PHP_URL_PATH ),
221 'compareTwoMode' => absint( $compare_two_mode ), // Apparently booleans are not allowed
222 'revisionIds' => array_keys( $revisions ),