wp_autosave() WordPress Function

The wp_autosave() function automatically saves a post or page as a draft whenever it is updated. This function is useful for making sure that your content is always saved, even if you forget to hit the "Save Draft" button.

wp_autosave( array $post_data ) #

Saves a post submitted with XHR.

Description
Parameters
Return
Source
Related
- Uses
- Used By
Changelog

Description

Intended for use with heartbeat and autosave.js

Top ↑

Parameters

$post_data: (array)(Required)Associative array of the submitted post data.

Top ↑

Return

(mixed) The value 0 or WP_Error on failure. The saved post ID on success. The ID can be the draft post_id or the autosave revision post_id.

Top ↑

Source

File: wp-admin/includes/post.php

function wp_autosave( $post_data ) {
    // Back-compat.
    if ( ! defined( 'DOING_AUTOSAVE' ) ) {
        define( 'DOING_AUTOSAVE', true );
    }
 
    $post_id              = (int) $post_data['post_id'];
    $post_data['ID']      = $post_id;
    $post_data['post_ID'] = $post_id;
 
    if ( false === wp_verify_nonce( $post_data['_wpnonce'], 'update-post_' . $post_id ) ) {
        return new WP_Error( 'invalid_nonce', __( 'Error while saving.' ) );
    }
 
    $post = get_post( $post_id );
 
    if ( ! current_user_can( 'edit_post', $post->ID ) ) {
        return new WP_Error( 'edit_posts', __( 'Sorry, you are not allowed to edit this item.' ) );
    }
 
    if ( 'auto-draft' === $post->post_status ) {
        $post_data['post_status'] = 'draft';
    }
 
    if ( 'page' !== $post_data['post_type'] && ! empty( $post_data['catslist'] ) ) {
        $post_data['post_category'] = explode( ',', $post_data['catslist'] );
    }
 
    if ( ! wp_check_post_lock( $post->ID ) && get_current_user_id() == $post->post_author
        && ( 'auto-draft' === $post->post_status || 'draft' === $post->post_status )
    ) {
        // Drafts and auto-drafts are just overwritten by autosave for the same user if the post is not locked.
        return edit_post( wp_slash( $post_data ) );
    } else {
        // Non-drafts or other users' drafts are not overwritten.
        // The autosave is stored in a special post revision for each user.
        return wp_create_post_autosave( wp_slash( $post_data ) );
    }
}

Expand full source code Collapse full source codeView on TracView on GitHub

Top ↑

Uses

Uses
Uses	Description
wp-admin/includes/post.php:wp_check_post_lock()	Determines whether the post is currently being edited by another user.
wp-admin/includes/post.php:wp_create_post_autosave()	Creates autosave data for the specified post from `$_POST` data.
wp-admin/includes/post.php:edit_post()	Updates an existing post with values provided in `$_POST`.
wp-includes/capabilities.php:current_user_can()	Returns whether the current user has the specified capability.
wp-includes/l10n.php:__()	Retrieve the translation of $text.
wp-includes/formatting.php:wp_slash()	Adds slashes to a string or recursively adds slashes to strings within an array.
wp-includes/pluggable.php:wp_verify_nonce()	Verifies that a correct security nonce was used with time limit.
wp-includes/user.php:get_current_user_id()	Gets the current user’s ID.
wp-includes/post.php:get_post()	Retrieves post data given a post ID or post object.
wp-includes/class-wp-error.php:WP_Error::__construct()	Initializes the error.