wp_prepare_revisions_for_js( WP_Post|int $post, int $selected_revision_id, int $from = null ): array

Parameters

$postWP_Post|int

The post object or post ID.

$selected_revision_idint

The selected revision ID.

$fromintoptional

The revision ID to compare from.Default: null

Return

array

An associative array of revision data and related settings.

Hooks fired · 1

One hook fires while wp_prepare_revisions_for_js() runs, in this order:

1. 1
   apply_filters( wp_prepare_revision_for_js )filterline 282 (+106 into the body)

   Filters the array of revisions used on the revisions screen.

Uses · 21

• get_post()Retrieves post data given a post ID or post object.
• wp_get_post_revisions()Returns all revisions of specified post.
• wp_revisions_enabled()Determines whether revisions are enabled for a given post.
• wp_is_post_autosave()Determines if the specified post is an autosave.
• get_option()Retrieves an option value based on an option name.
• update_post_author_caches()Updates post author user caches for a list of post objects.
• current_user_can()Returns whether the current user has the specified capability.
• wp_nonce_url()Retrieves URL with nonce added to URL query.
• add_query_arg()Retrieves a modified URL query string.
• admin_url()Retrieves the URL to the admin area for the current site.
• get_avatar()Retrieves the avatar `` tag for a user, email address, MD5 hash, comment, or post.
• get_the_author_meta()Retrieves the requested data of the author of the current post.

Source

View on Trac ↗View on GitHub ↗

176function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null ) {177	$post    = get_post( $post );178	$authors = array();179	$now_gmt = time();180 181	$revisions = wp_get_post_revisions(182		$post->ID,183		array(184			'order'         => 'ASC',185			'check_enabled' => false,186		)187	);188	// If revisions are disabled, we only want autosaves and the current post.189	if ( ! wp_revisions_enabled( $post ) ) {190		foreach ( $revisions as $revision_id => $revision ) {191			if ( ! wp_is_post_autosave( $revision ) ) {192				unset( $revisions[ $revision_id ] );193			}194		}195		$revisions = array( $post->ID => $post ) + $revisions;196	}197 198	$show_avatars = get_option( 'show_avatars' );199 200	update_post_author_caches( $revisions );201 202	$can_restore = current_user_can( 'edit_post', $post->ID );203	$current_id  = false;204 205	foreach ( $revisions as $revision ) {206		$modified     = strtotime( $revision->post_modified );207		$modified_gmt = strtotime( $revision->post_modified_gmt . ' +0000' );208		if ( $can_restore ) {209			$restore_link = str_replace(210				'&amp;',211				'&',212				wp_nonce_url(213					add_query_arg(214						array(215							'revision' => $revision->ID,216							'action'   => 'restore',217						),218						admin_url( 'revision.php' )219					),220					"restore-post_{$revision->ID}"221				)222			);223		}224 225		if ( ! isset( $authors[ $revision->post_author ] ) ) {226			$authors[ $revision->post_author ] = array(227				'id'     => (int) $revision->post_author,228				'avatar' => $show_avatars ? get_avatar( $revision->post_author, 32 ) : '',229				'name'   => get_the_author_meta( 'display_name', $revision->post_author ),230			);231		}232 233		$autosave = (bool) wp_is_post_autosave( $revision );234		$current  = ! $autosave && $revision->post_modified_gmt === $post->post_modified_gmt;235		if ( $current && ! empty( $current_id ) ) {236			// If multiple revisions have the same post_modified_gmt, highest ID is current.237			if ( $current_id < $revision->ID ) {238				$revisions[ $current_id ]['current'] = false;239				$current_id                          = $revision->ID;240			} else {241				$current = false;242			}243		} elseif ( $current ) {244			$current_id = $revision->ID;245		}246 247		$revisions_data = array(248			'id'         => $revision->ID,249			'title'      => get_the_title( $post->ID ),250			'author'     => $authors[ $revision->post_author ],251			'date'       => date_i18n( __( 'M j, Y @ H:i' ), $modified ),252			'dateShort'  => date_i18n( _x( 'j M @ H:i', 'revision date short format' ), $modified ),253			/* translators: %s: Human-readable time difference. */254			'timeAgo'    => sprintf( __( '%s ago' ), human_time_diff( $modified_gmt, $now_gmt ) ),255			'autosave'   => $autosave,

History

Introduced in 3.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/revision.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.