wp_update_post() WordPress Function

The wp_update_post() function is used to update a post in the WordPress database. This function takes two arguments: the post ID of the post to update, and an array of data containing the updated post data. This function can be used to update any post field, including the post title, content, excerpt, status, and more. Updating a post is a two-step process: first, the post is updated in the database, and then the post is reloaded from the database and returned to the caller. The wp_update_post() function is the preferred way to update a post in WordPress. It is more efficient than using the get_post() function to load a post from the database, and then using the wp_insert_post() or wp_update_post() function to save the updated post back to the database.

wp_update_post( array|object $postarr = array(), bool $wp_error = false, bool $fire_after_hooks = true ) #

Update a post with new post data.

Contents

Description

The date does not have to be set for drafts. You can set the date and it will not be overridden.

Top ↑

Parameters

$postarr

(array|object)(Optional) Post data. Arrays are expected to be escaped, objects are not. See wp_insert_post() for accepted arguments. Default array.

Default value: array()

$wp_error

(bool)(Optional) Whether to return a WP_Error on failure.

Default value: false

$fire_after_hooks

(bool)(Optional) Whether to fire the after insert hooks.

Default value: true

Top ↑

Return

(int|WP_Error) The post ID on success. The value 0 or WP_Error on failure.

Top ↑

Source

File: wp-includes/post.php

4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
function wp_update_post( $postarr = array(), $wp_error = false, $fire_after_hooks = true ) {
    if ( is_object( $postarr ) ) {
        // Non-escaped post was passed.
        $postarr = get_object_vars( $postarr );
        $postarr = wp_slash( $postarr );
    }
 
    // First, get all of the original fields.
    $post = get_post( $postarr['ID'], ARRAY_A );
 
    if ( is_null( $post ) ) {
        if ( $wp_error ) {
            return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) );
        }
        return 0;
    }
 
    // Escape data pulled from DB.
    $post = wp_slash( $post );
 
    // Passed post category list overwrites existing category list if not empty.
    if ( isset( $postarr['post_category'] ) && is_array( $postarr['post_category'] )
        && count( $postarr['post_category'] ) > 0
    ) {
        $post_cats = $postarr['post_category'];
    } else {
        $post_cats = $post['post_category'];
    }
 
    // Drafts shouldn't be assigned a date unless explicitly done so by the user.
    if ( isset( $post['post_status'] )
        && in_array( $post['post_status'], array( 'draft', 'pending', 'auto-draft' ), true )
        && empty( $postarr['edit_date'] ) && ( '0000-00-00 00:00:00' === $post['post_date_gmt'] )
    ) {
        $clear_date = true;
    } else {
        $clear_date = false;
    }
 
    // Merge old and new fields with new fields overwriting old ones.
    $postarr                  = array_merge( $post, $postarr );
    $postarr['post_category'] = $post_cats;
    if ( $clear_date ) {
        $postarr['post_date']     = current_time( 'mysql' );
        $postarr['post_date_gmt'] = '';
    }
 
    if ( 'attachment' === $postarr['post_type'] ) {
        return wp_insert_attachment( $postarr, false, 0, $wp_error );
    }
 
    // Discard 'tags_input' parameter if it's the same as existing post tags.
    if ( isset( $postarr['tags_input'] ) && is_object_in_taxonomy( $postarr['post_type'], 'post_tag' ) ) {
        $tags      = get_the_terms( $postarr['ID'], 'post_tag' );
        $tag_names = array();
 
        if ( $tags && ! is_wp_error( $tags ) ) {
            $tag_names = wp_list_pluck( $tags, 'name' );
        }
 
        if ( $postarr['tags_input'] === $tag_names ) {
            unset( $postarr['tags_input'] );
        }
    }
 
    return wp_insert_post( $postarr, $wp_error, $fire_after_hooks );
}

Expand full source codeCollapse full source codeView on TracView on GitHub

Top ↑

Top ↑

Uses

Uses
UsesDescription
wp-includes/category-template.php:get_the_terms()

Retrieves the terms of the taxonomy that are attached to the post.

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/functions.php:wp_list_pluck()

Plucks a certain field out of each object or array in an array.

wp-includes/functions.php:current_time()

Retrieves the current time based on specified type.

wp-includes/taxonomy.php:is_object_in_taxonomy()

Determines if the given object type is associated with the given taxonomy.

wp-includes/post.php:wp_insert_attachment()

Insert an attachment.

wp-includes/post.php:wp_insert_post()

Insert or update a post.

wp-includes/post.php:get_post()

Retrieves post data given a post ID or post object.

wp-includes/load.php:is_wp_error()

Checks whether the given variable is a WordPress Error.

wp-includes/class-wp-error.php:WP_Error::__construct()

Initializes the error.

Show 6 more usesHide more uses

Top ↑

Used By

Used By
Used ByDescription
wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php:WP_REST_Global_Styles_Controller::update_item()

Updates a single global style config.

wp-includes/theme-templates.php:wp_set_unique_slug_on_create_template_part()

Sets a custom slug when creating auto-draft template parts.

wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php:WP_REST_Templates_Controller::update_item()

Updates a single template.

wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php:WP_REST_Autosaves_Controller::create_item()

Creates, updates or deletes an autosave revision.

wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php:WP_REST_Autosaves_Controller::create_post_autosave()

Creates autosave for the specified post.

wp-includes/user.php:wp_generate_user_request_key()

Returns a confirmation key for a user action and stores the hashed version for future comparison.

wp-includes/user.php:_wp_privacy_account_request_confirmed()

Updates log when privacy request is confirmed.

wp-admin/includes/privacy-tools.php:_wp_privacy_completed_request()

Marks a request as completed by the admin and logs the current timestamp.

wp-admin/includes/privacy-tools.php:_wp_personal_data_cleanup_requests()

Cleans up failed and expired requests before displaying the list table.

wp-includes/class-wp-customize-manager.php:WP_Customize_Manager::save_changeset_post()

Saves the post for the loaded changeset.

wp-includes/theme.php:wp_update_custom_css_post()

Updates the custom_css post for a given theme.

wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php:WP_REST_Posts_Controller::update_item()

Updates a single post.

wp-includes/class-wp-customize-nav-menus.php:WP_Customize_Nav_Menus::save_nav_menus_created_posts()

Publishes the auto-draft posts that were created for nav menu items.

wp-admin/includes/media.php:media_upload_form_handler()

Handles form submissions for the legacy media uploader.

wp-admin/includes/post.php:wp_create_post_autosave()

Creates autosave data for the specified post from $_POST data.

wp-admin/includes/post.php:_fix_attachment_links()

Replaces hrefs of attachment anchors with up-to-date permalinks.

wp-admin/includes/post.php:edit_post()

Updates an existing post with values provided in $_POST.

wp-admin/includes/post.php:bulk_edit_posts()

Processes the post data for the bulk editing of posts.

wp-admin/includes/ajax-actions.php:wp_ajax_save_attachment_order()

Ajax handler for saving the attachment order.

wp-admin/includes/ajax-actions.php:wp_ajax_send_attachment_to_editor()

Ajax handler for sending an attachment to the editor.

wp-admin/includes/ajax-actions.php:wp_ajax_save_attachment()

Ajax handler for updating attachment attributes.

wp-admin/includes/ajax-actions.php:wp_ajax_save_attachment_compat()

Ajax handler for saving backward compatible attachment attributes.

wp-includes/class-wp-embed.php:WP_Embed::shortcode()

The do_shortcode() callback function.

wp-includes/post.php:wp_check_post_hierarchy_for_loops()

Check the given subset of the post hierarchy for hierarchy loops.

wp-includes/post.php:wp_trash_post()

Move a post or page to the Trash

wp-includes/post.php:wp_untrash_post()

Restores a post from the Trash.

wp-includes/revision.php:wp_restore_post_revision()

Restores a post to the specified revision.

wp-includes/nav-menu.php:wp_update_nav_menu_item()

Saves the properties of a menu item or create a new one.

wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::mt_publishPost()

Sets a post’s publish status to ‘publish’.

wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::mw_editPost()

Edit a post.

wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::blogger_editPost()

Edit a post.

wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::_insert_post()

Helper method for wp_newPost() and wp_editPost(), containing shared logic.

Show 27 more used byHide more used by

Top ↑

Changelog

Changelog
VersionDescription
5.6.0Added the $fire_after_hooks parameter.
3.5.0Added the $wp_error parameter to allow a WP_Error to be returned on failure.
1.0.0Introduced.
Download the latest version of WordPress from https://wordpress.org/

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More