WP_REST_Autosaves_Controller::create_post_autosave( array $post_data, array $meta = array() ): mixed

Description

Compatibility

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

Parameters

$post_dataarray

Associative array containing the post data.

$metaarrayoptional

Associative array containing the post meta data.Default: array()

Return value

mixed

The autosave revision ID or WP_Error.

Performance profile

How much work a call to WP_REST_Autosaves_Controller::create_post_autosave() 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

13–112

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

Plugin surface

1 hook

Third-party callbacks on 'wp_creating_autosave' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place 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 callbacksdo_action()called directly
• cacheobject cachewp_cache_get()one call below WP_REST_Autosaves_Controller::create_post_autosave()
• serializeserialisationmaybe_unserialize()one call below WP_REST_Autosaves_Controller::create_post_autosave()

Further down the call graph this can also reach option 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 · 19 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   do_action( wp_creating_autosave )actionline 416 (+50 into the body)

   Fires before an autosave is stored.

Uses · 14

• get_post()Retrieves post data given a post ID or post object.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• _wp_post_revision_data()Returns a post array ready to be inserted into the posts table as a post revision.
• _wp_post_revision_fields()Determines which fields of posts are to be saved in revisions.
• normalize_whitespace()Normalizes EOL characters and strips duplicate whitespace.
• wp_post_revision_meta_keys()Determine which post meta fields should be revisioned.
• get_metadata_raw()Retrieves raw metadata value for the specified object.
• get_current_user_id()Gets the current user's ID.
• wp_get_post_autosave()Retrieves the autosaved data of the specified post.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_update_post()Updates a post with new post data.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.

Used by · 1

• WP_REST_Autosaves_Controller::create_item()Creates, updates or deletes an autosave revision.

Source code

View on Trac ↗View on GitHub ↗

366	public function create_post_autosave( $post_data, array $meta = array() ) {367 368		$post_id = (int) $post_data['ID'];369		$post    = get_post( $post_id );370 371		if ( is_wp_error( $post ) ) {372			return $post;373		}374 375		// Only create an autosave when it is different from the saved post.376		$autosave_is_different = false;377		$new_autosave          = _wp_post_revision_data( $post_data, true );378 379		foreach ( array_intersect( array_keys( $new_autosave ), array_keys( _wp_post_revision_fields( $post ) ) ) as $field ) {380			if ( normalize_whitespace( $new_autosave[ $field ] ) !== normalize_whitespace( $post->$field ) ) {381				$autosave_is_different = true;382				break;383			}384		}385 386		// Check if meta values have changed.387		if ( ! empty( $meta ) ) {388			$revisioned_meta_keys = wp_post_revision_meta_keys( $post->post_type );389			foreach ( $revisioned_meta_keys as $meta_key ) {390				// get_metadata_raw is used to avoid retrieving the default value.391				$old_meta = get_metadata_raw( 'post', $post_id, $meta_key, true );392				$new_meta = isset( $meta[ $meta_key ] ) ? $meta[ $meta_key ] : '';393 394				if ( $new_meta !== $old_meta ) {395					$autosave_is_different = true;396					break;397				}398			}399		}400 401		$user_id = get_current_user_id();402 403		// Store one autosave per author. If there is already an autosave, overwrite it.404		$old_autosave = wp_get_post_autosave( $post_id, $user_id );405 406		if ( ! $autosave_is_different && $old_autosave ) {407			// Nothing to save, return the existing autosave.408			return $old_autosave->ID;409		}410 411		if ( $old_autosave ) {412			$new_autosave['ID']          = $old_autosave->ID;413			$new_autosave['post_author'] = $user_id;414 415			/** This filter is documented in wp-admin/post.php */416			do_action( 'wp_creating_autosave', $new_autosave );417 418			// wp_update_post() expects escaped array.419			$revision_id = wp_update_post( wp_slash( $new_autosave ) );420		} else {421			// Create the new autosave as a special post revision.422			$revision_id = _wp_put_post_revision( $post_data, true );423		}424 425		if ( is_wp_error( $revision_id ) || 0 === $revision_id ) {426			return $revision_id;427		}428 429		// Attached any passed meta values that have revisions enabled.430		if ( ! empty( $meta ) ) {431			foreach ( $revisioned_meta_keys as $meta_key ) {432				if ( isset( $meta[ $meta_key ] ) ) {433					update_metadata( 'post', $revision_id, $meta_key, wp_slash( $meta[ $meta_key ] ) );434				}435			}436		}437 438		return $revision_id;439	}

Changelog

Introduced in 5.0.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-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.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.