wp_create_post_autosave( array|int $post_data ): int|WP_Error

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|int

Associative array containing the post data, or integer post ID.
If a numeric post ID is provided, will use the $_POST superglobal.

Return value

int|WP_Error

The autosave revision ID. WP_Error or 0 on error.

Performance profile

How much work a call to wp_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

15–83

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

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

3

3 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 callbacksdo_action()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 · 7 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while wp_create_post_autosave() runs, in this order:

1. 1
   do_action( wp_creating_autosave )actionline 2005 (+48 into the body)

   Fires before an autosave is stored.

2. 2
   do_action( wp_creating_autosave )actionline 2018 (+61 into the body)

   Fires before an autosave is stored.

Uses · 14

• _wp_translate_postdata()Renames `$_POST` data from form names to DB post columns.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• _wp_get_allowed_postdata()Returns only allowed post data fields.
• get_current_user_id()Gets the current user's ID.
• wp_get_post_autosave()Retrieves the autosaved data of the specified post.
• _wp_post_revision_data()Returns a post array ready to be inserted into the posts table as a post revision.
• get_post()Retrieves post data given a post ID or post object.
• _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_delete_post_revision()Deletes a revision.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_update_post()Updates a post with new post data.

Used by · 3

• WP_Customize_Manager::save_changeset_post()Saves the post for the loaded changeset.
• post_preview()Saves a draft or manually autosaves for the purpose of showing a post preview.
• wp_autosave()Saves a post submitted with XHR.

Source code

View on Trac ↗View on GitHub ↗

1957function wp_create_post_autosave( $post_data ) {1958	if ( is_numeric( $post_data ) ) {1959		$post_id   = $post_data;1960		$post_data = $_POST;1961	} else {1962		$post_id = (int) $post_data['post_ID'];1963	}1964 1965	$post_data = _wp_translate_postdata( true, $post_data );1966	if ( is_wp_error( $post_data ) ) {1967		return $post_data;1968	}1969	$post_data = _wp_get_allowed_postdata( $post_data );1970 1971	$post_author = get_current_user_id();1972 1973	// Store one autosave per author. If there is already an autosave, overwrite it.1974	$old_autosave = wp_get_post_autosave( $post_id, $post_author );1975	if ( $old_autosave ) {1976		$new_autosave                = _wp_post_revision_data( $post_data, true );1977		$new_autosave['ID']          = $old_autosave->ID;1978		$new_autosave['post_author'] = $post_author;1979 1980		$post = get_post( $post_id );1981 1982		// If the new autosave has the same content as the post, delete the autosave.1983		$autosave_is_different = false;1984		foreach ( array_intersect( array_keys( $new_autosave ), array_keys( _wp_post_revision_fields( $post ) ) ) as $field ) {1985			if ( normalize_whitespace( $new_autosave[ $field ] ) !== normalize_whitespace( $post->$field ) ) {1986				$autosave_is_different = true;1987				break;1988			}1989		}1990 1991		if ( ! $autosave_is_different ) {1992			wp_delete_post_revision( $old_autosave->ID );1993			return 0;1994		}1995 1996		/**1997		 * Fires before an autosave is stored.1998		 *1999		 * @since 4.1.02000		 * @since 6.4.0 The `$is_update` parameter was added to indicate if the autosave is being updated or was newly created.2001		 *2002		 * @param array $new_autosave Post array - the autosave that is about to be saved.2003		 * @param bool  $is_update    Whether this is an existing autosave.2004		 */2005		do_action( 'wp_creating_autosave', $new_autosave, true );2006		return wp_update_post( $new_autosave );2007	}2008 2009	// _wp_put_post_revision() expects unescaped.2010	$post_data = wp_unslash( $post_data );2011 2012	// Otherwise create the new autosave as a special post revision.2013	$revision = _wp_put_post_revision( $post_data, true );2014 2015	if ( ! is_wp_error( $revision ) && 0 !== $revision ) {2016 2017		/** This action is documented in wp-admin/includes/post.php */2018		do_action( 'wp_creating_autosave', get_post( $revision, ARRAY_A ), false );2019	}2020 2021	return $revision;2022}

Changelog

Introduced in 2.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.0.4 tag, from src/wp-admin/includes/post.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.