wp_get_revision_ui_diff( WP_Post|int $post, int $compare_from, int $compare_to ): array|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$postWP_Post|int

The post object or post ID.

$compare_fromint

The revision ID to compare from.

$compare_toint

The revision ID to come to.

Return value

array|false

Associative array of a post's revisioned fields and their diffs.
Or, false on failure.

Performance profile

How much work a call to wp_get_revision_ui_diff() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

9–79

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 188.

Plugin surface

3 hooks

Third-party callbacks on '_wp_post_revision_field_{$field}', 'revision_text_diff_options', 'wp_get_revision_ui_diff' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 13 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_revision_ui_diff() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 4

4 hooks fire while wp_get_revision_ui_diff() runs, in this order:

1. 1
   apply_filters( _wp_post_revision_field_{$field} )filterline 90 (+69 into the body)

   Contextually filter a post revision field.

2. 2
   apply_filters( _wp_post_revision_field_{$field} )filterline 93 (+72 into the body)

   Contextually filter a post revision field.

3. 3
   apply_filters( revision_text_diff_options )filterline 118 (+97 into the body)

   Filters revisions text diff options.

4. 4
   apply_filters( wp_get_revision_ui_diff )filterline 163 (+142 into the body)

   Filters the fields displayed in the post revision diff UI.

Uses · 6

• get_post()Retrieves post data given a post ID or post object.
• __()Retrieves the translation of $text.
• _wp_post_revision_fields()Determines which fields of posts are to be saved in revisions.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_text_diff()Displays a human readable HTML representation of the difference between two strings.
• esc_html()Escaping for HTML blocks.

Used by · 2

• wp_ajax_get_revision_diffs()Handles getting revision diffs via AJAX.
• wp_prepare_revisions_for_js()Prepare revisions for JavaScript.

Source code

View on Trac ↗View on GitHub ↗

21function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {22	$post = get_post( $post );23	if ( ! $post ) {24		return false;25	}26 27	if ( $compare_from ) {28		$compare_from = get_post( $compare_from );29		if ( ! $compare_from ) {30			return false;31		}32	} else {33		// If we're dealing with the first revision...34		$compare_from = false;35	}36 37	$compare_to = get_post( $compare_to );38	if ( ! $compare_to ) {39		return false;40	}41 42	/*43	 * If comparing revisions, make sure we are dealing with the right post parent.44	 * The parent post may be a 'revision' when revisions are disabled and we're looking at autosaves.45	 */46	if ( $compare_from && $compare_from->post_parent !== $post->ID && $compare_from->ID !== $post->ID ) {47		return false;48	}49	if ( $compare_to->post_parent !== $post->ID && $compare_to->ID !== $post->ID ) {50		return false;51	}52 53	if ( $compare_from && strtotime( $compare_from->post_date_gmt ) > strtotime( $compare_to->post_date_gmt ) ) {54		$temp         = $compare_from;55		$compare_from = $compare_to;56		$compare_to   = $temp;57	}58 59	// Add default title if title field is empty.60	if ( $compare_from && empty( $compare_from->post_title ) ) {61		$compare_from->post_title = __( '(no title)' );62	}63	if ( empty( $compare_to->post_title ) ) {64		$compare_to->post_title = __( '(no title)' );65	}66 67	$return = array();68 69	foreach ( _wp_post_revision_fields( $post ) as $field => $name ) {70		/**71		 * Contextually filter a post revision field.72		 *73		 * The dynamic portion of the hook name, `$field`, corresponds to a name of a74		 * field of the revision object.75		 *76		 * Possible hook names include:77		 *78		 *  - `_wp_post_revision_field_post_title`79		 *  - `_wp_post_revision_field_post_content`80		 *  - `_wp_post_revision_field_post_excerpt`81		 *82		 * @since 3.6.083		 *84		 * @param string  $revision_field The current revision field to compare to or from.85		 * @param string  $field          The current revision field.86		 * @param WP_Post $compare_from   The revision post object to compare to or from.87		 * @param string  $context        The context of whether the current revision is the old88		 *                                or the new one. Either 'to' or 'from'.89		 */90		$content_from = $compare_from ? apply_filters( "_wp_post_revision_field_{$field}", $compare_from->$field, $field, $compare_from, 'from' ) : '';91 92		/** This filter is documented in wp-admin/includes/revision.php */93		$content_to = apply_filters( "_wp_post_revision_field_{$field}", $compare_to->$field, $field, $compare_to, 'to' );94 95		$args = array(96			'show_split_view' => true,97			'title_left'      => __( 'Removed' ),98			'title_right'     => __( 'Added' ),99		);100

Changelog

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 7.1.0 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.