X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..d3947bc013df7edd54b46deed8230d2eeafc5ecb:/wp-admin/includes/revision.php diff --git a/wp-admin/includes/revision.php b/wp-admin/includes/revision.php index 737c3b16..3f038f12 100644 --- a/wp-admin/includes/revision.php +++ b/wp-admin/includes/revision.php @@ -4,6 +4,7 @@ * * @package WordPress * @subpackage Administration + * @since 3.6.0 */ /** @@ -54,11 +55,11 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) { $return = array(); - foreach ( _wp_post_revision_fields() as $field => $name ) { + foreach ( _wp_post_revision_fields( $post ) as $field => $name ) { /** * Contextually filter a post revision field. * - * The dynamic portion of the hook name, $field, corresponds to each of the post + * The dynamic portion of the hook name, `$field`, corresponds to each of the post * fields of the revision object being iterated over in a foreach statement. * * @since 3.6.0 @@ -66,14 +67,38 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) { * @param string $compare_from->$field The current revision field to compare to or from. * @param string $field The current revision field. * @param WP_Post $compare_from The revision post object to compare to or from. - * @param string null The context of whether the current revision is the old or the new one. Values are 'to' or 'from'. + * @param string null The context of whether the current revision is the old + * or the new one. Values are 'to' or 'from'. */ $content_from = $compare_from ? apply_filters( "_wp_post_revision_field_$field", $compare_from->$field, $field, $compare_from, 'from' ) : ''; /** This filter is documented in wp-admin/includes/revision.php */ $content_to = apply_filters( "_wp_post_revision_field_$field", $compare_to->$field, $field, $compare_to, 'to' ); - $diff = wp_text_diff( $content_from, $content_to, array( 'show_split_view' => true ) ); + $args = array( + 'show_split_view' => true + ); + + /** + * Filter revisions text diff options. + * + * Filter the options passed to {@see wp_text_diff()} when viewing a post revision. + * + * @since 4.1.0 + * + * @param array $args { + * Associative array of options to pass to {@see wp_text_diff()}. + * + * @type bool $show_split_view True for split view (two columns), false for + * un-split view (single column). Default true. + * } + * @param string $field The current revision field. + * @param WP_Post $compare_from The revision post to compare from. + * @param WP_Post $compare_to The revision post to compare to. + */ + $args = apply_filters( 'revision_text_diff_options', $args, $field, $compare_from, $compare_to ); + + $diff = wp_text_diff( $content_from, $content_to, $args ); if ( ! $diff && 'post_title' === $field ) { // It's a better user experience to still show the Title, even if it didn't change. @@ -92,7 +117,18 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) { ); } } - return $return; + + /** + * Filter the fields displayed in the post revision diff UI. + * + * @since 4.1.0 + * + * @param array $return Revision UI fields. Each item is an array of id, name and diff. + * @param WP_Post $compare_from The revision post to compare from. + * @param WP_Post $compare_to The revision post to compare to. + */ + return apply_filters( 'wp_get_revision_ui_diff', $return, $compare_from, $compare_to ); + } /** @@ -108,7 +144,7 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) { */ function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null ) { $post = get_post( $post ); - $revisions = $authors = array(); + $authors = array(); $now_gmt = time(); $revisions = wp_get_post_revisions( $post->ID, array( 'order' => 'ASC', 'check_enabled' => false ) ); @@ -126,6 +162,7 @@ function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null cache_users( wp_list_pluck( $revisions, 'post_author' ) ); $can_restore = current_user_can( 'edit_post', $post->ID ); + $current_id = false; foreach ( $revisions as $revision ) { $modified = strtotime( $revision->post_modified ); @@ -163,21 +200,67 @@ function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null $current_id = $revision->ID; } - $revisions[ $revision->ID ] = array( + $revisions_data = array( 'id' => $revision->ID, 'title' => get_the_title( $post->ID ), 'author' => $authors[ $revision->post_author ], - 'date' => date_i18n( __( 'M j, Y @ G:i' ), $modified ), - 'dateShort' => date_i18n( _x( 'j M @ G:i', 'revision date short format' ), $modified ), + 'date' => date_i18n( __( 'M j, Y @ H:i' ), $modified ), + 'dateShort' => date_i18n( _x( 'j M @ H:i', 'revision date short format' ), $modified ), 'timeAgo' => sprintf( __( '%s ago' ), human_time_diff( $modified_gmt, $now_gmt ) ), 'autosave' => $autosave, 'current' => $current, 'restoreUrl' => $can_restore ? $restore_link : false, ); + + /** + * Filter the array of revisions used on the revisions screen. + * + * @since 4.4.0 + * + * @param array $revisions_data { + * The bootstrapped data for the revisions screen. + * + * @type int $id Revision ID. + * @type string $title Title for the revision's parent WP_Post object. + * @type int $author Revision post author ID. + * @type string $date Date the revision was modified. + * @type string $dateShort Short-form version of the date the revision was modified. + * @type string $timeAgo GMT-aware amount of time ago the revision was modified. + * @type bool $autosave Whether the revision is an autosave. + * @type bool $current Whether the revision is both not an autosave and the post + * modified date matches the revision modified date (GMT-aware). + * @type bool|false $restoreUrl URL if the revision can be restored, false otherwise. + * } + * @param WP_Post $revision The revision's WP_Post object. + * @param WP_Post $post The revision's parent WP_Post object. + */ + $revisions[ $revision->ID ] = apply_filters( 'wp_prepare_revision_for_js', $revisions_data, $revision, $post ); + } + + /** + * If we only have one revision, the initial revision is missing; This happens + * when we have an autsosave and the user has clicked 'View the Autosave' + */ + if ( 1 === sizeof( $revisions ) ) { + $revisions[ $post->ID ] = array( + 'id' => $post->ID, + 'title' => get_the_title( $post->ID ), + 'author' => $authors[ $post->post_author ], + 'date' => date_i18n( __( 'M j, Y @ H:i' ), strtotime( $post->post_modified ) ), + 'dateShort' => date_i18n( _x( 'j M @ H:i', 'revision date short format' ), strtotime( $post->post_modified ) ), + 'timeAgo' => sprintf( __( '%s ago' ), human_time_diff( strtotime( $post->post_modified_gmt ), $now_gmt ) ), + 'autosave' => false, + 'current' => true, + 'restoreUrl' => false, + ); + $current_id = $post->ID; } - // If a post has been saved since the last revision (no revisioned fields were changed) - // we may not have a "current" revision. Mark the latest revision as "current". + /* + * If a post has been saved since the last revision (no revisioned fields + * were changed), we may not have a "current" revision. Mark the latest + * revision as "current". + */ if ( empty( $current_id ) ) { if ( $revisions[ $revision->ID ]['autosave'] ) { $revision = end( $revisions ); @@ -191,7 +274,7 @@ function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null $revisions[ $current_id ]['current'] = true; } - // Now, grab the initial diff + // Now, grab the initial diff. $compare_two_mode = is_numeric( $from ); if ( ! $compare_two_mode ) { $found = array_search( $selected_revision_id, array_keys( $revisions ) ); @@ -222,3 +305,99 @@ function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null 'revisionIds' => array_keys( $revisions ), ); } + +/** + * Print JavaScript templates required for the revisions experience. + * + * @since 4.1.0 + * + * @global WP_Post $post The global `$post` object. + */ +function wp_print_revision_templates() { + global $post; + ?> + + + + + + + +