wp_get_post_autosave( int $post_id, int $user_id = 0 ): WP_Post|false
- Since
- 2.6.0
- Source
wp-includes/revision.php:277
Description
Returns a post object with the information that was autosaved for the specified post.
If the optional $user_id is passed, returns the autosave for that user, otherwise returns the latest autosave.
Compatibility
- WordPress
- since 2.6.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$post_idint- The post ID.
$user_idintoptional- The post author ID. Default 0.Default:
0
Return value
WP_Post|false- The autosaved data or false on failure or when no autosave exists.
Performance profile
How much work a call to wp_get_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
- Scaling
- Constant
- Instructions
- 23–31
- Plugin surface
- None
- Called by
- 10
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 32.
Nothing here hands control to plugin code.
10 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly
Further down the call graph this can also reach hook, 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_post_autosave() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!->have_posts() | 23–25 | revision(), ->have_posts() |
->have_posts() | 29–31 | revision(), ->have_posts(), get_post() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 32 instructions, 23–31 executed per call, 2 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- get_post()Retrieves post data given a post ID or post object.
- WP_Query::__construct()Constructor.
Used by · 10
- WP_Customize_Manager::changeset_data()Gets changeset data.
- WP_Customize_Manager::customize_pane_settings()Prints JavaScript settings for parent window.
- WP_Customize_Manager::handle_dismiss_autosave_or_lock_request()Deletes a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock.
- WP_Customize_Manager::save_changeset_post()Saves the post for the loaded changeset.
- WP_REST_Autosaves_Controller::create_post_autosave()Creates autosave for the specified post.
- WP_REST_Autosaves_Controller::get_item()Get the autosave, if the ID is valid.
- WP_REST_Template_Autosaves_Controller::get_item()Gets the autosave, if the ID is valid.
- _set_preview()Sets up the post object for preview based on the post autosave.
- _wp_preview_meta_filter()Filters preview post meta retrieval to get values from the autosave.
- wp_create_post_autosave()Creates autosave data for the specified post from `$_POST` data.
Source code
function wp_get_post_autosave( $post_id, $user_id = 0 ) { $args = array( 'post_type' => 'revision', 'post_status' => 'inherit', 'post_parent' => $post_id, 'name' => $post_id . '-autosave-v1', 'posts_per_page' => 1, 'orderby' => 'date', 'order' => 'DESC', 'fields' => 'ids', 'no_found_rows' => true, ); if ( 0 !== $user_id ) { $args['author'] = $user_id; } $query = new WP_Query( $args ); if ( ! $query->have_posts() ) { return false; } return get_post( $query->posts[0] );}Changelog
Introduced in 2.6.0. Unchanged from 6.7.7 through 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/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.