_wp_upgrade_revisions_of_post( WP_Post $post, array $revisions ): bool

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

Post object.

$revisionsarray

Current revisions of the post.

Return value

bool

true if the revisions were upgraded, false if problems.

Performance profile

How much work a call to _wp_upgrade_revisions_of_post() 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 ->query().

Scaling

Scales with input

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

Instructions

27–97

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_delete()called directly
• sqldatabase query->query()called directly
• hookthird-party callbacksapply_filters()one call below _wp_upgrade_revisions_of_post()
• serializeserialisationmaybe_unserialize()one call below _wp_upgrade_revisions_of_post()
• querycontent queryget_post()one call below _wp_upgrade_revisions_of_post()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 21 distinct outcomes

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

Uses · 6

• get_option()Retrieves an option value based on an option name.
• update_option()Updates the value of an option that was already added.
• _wp_get_post_revision_version()Gets the post revision version.
• wp_cache_delete()Removes the cache contents matching key and group.
• delete_option()Removes an option by name. Prevents removal of protected WordPress options.
• wp_save_post_revision()Creates a revision for the current version of a post.

Used by · 1

• edit_post()Updates an existing post with values provided in `$_POST`.

Source code

View on Trac ↗View on GitHub ↗

1001function _wp_upgrade_revisions_of_post( $post, $revisions ) {1002	global $wpdb;1003 1004	// Add post option exclusively.1005	$lock   = "revision-upgrade-{$post->ID}";1006	$now    = time();1007	$result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, 'off') /* LOCK */", $lock, $now ) );1008 1009	if ( ! $result ) {1010		// If we couldn't get a lock, see how old the previous lock is.1011		$locked = get_option( $lock );1012 1013		if ( ! $locked ) {1014			/*1015			 * Can't write to the lock, and can't read the lock.1016			 * Something broken has happened.1017			 */1018			return false;1019		}1020 1021		if ( $locked > $now - HOUR_IN_SECONDS ) {1022			// Lock is not too old: some other process may be upgrading this post. Bail.1023			return false;1024		}1025 1026		// Lock is too old - update it (below) and continue.1027	}1028 1029	// If we could get a lock, re-"add" the option to fire all the correct filters.1030	update_option( $lock, $now );1031 1032	reset( $revisions );1033	$add_last = true;1034 1035	do {1036		$this_revision = current( $revisions );1037		$prev_revision = next( $revisions );1038 1039		$this_revision_version = _wp_get_post_revision_version( $this_revision );1040 1041		// Something terrible happened.1042		if ( false === $this_revision_version ) {1043			continue;1044		}1045 1046		/*1047		 * 1 is the latest revision version, so we're already up to date.1048		 * No need to add a copy of the post as latest revision.1049		 */1050		if ( 0 < $this_revision_version ) {1051			$add_last = false;1052			continue;1053		}1054 1055		// Always update the revision version.1056		$update = array(1057			'post_name' => preg_replace( '/^(\d+-(?:autosave|revision))[\d-]*$/', '$1-v1', $this_revision->post_name ),1058		);1059 1060		/*1061		 * If this revision is the oldest revision of the post, i.e. no $prev_revision,1062		 * the correct post_author is probably $post->post_author, but that's only a good guess.1063		 * Update the revision version only and Leave the author as-is.1064		 */1065		if ( $prev_revision ) {1066			$prev_revision_version = _wp_get_post_revision_version( $prev_revision );1067 1068			// If the previous revision is already up to date, it no longer has the information we need :(1069			if ( $prev_revision_version < 1 ) {1070				$update['post_author'] = $prev_revision->post_author;1071			}1072		}1073 1074		// Upgrade this revision.1075		$result = $wpdb->update( $wpdb->posts, $update, array( 'ID' => $this_revision->ID ) );1076 1077		if ( $result ) {1078			wp_cache_delete( $this_revision->ID, 'posts' );1079		}1080	} while ( $prev_revision );

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 6.9.7 tag, from src/wp-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.