wp_update_post( array|object $postarr = array(), bool $wp_error = false, bool $fire_after_hooks = true ): int|WP_Error

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

$postarrarray|objectoptional

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

$wp_errorbooloptional

Whether to return a WP_Error on failure. Default false.Default: false

$fire_after_hooksbooloptional

Whether to fire the after insert hooks. Default true.Default: true

Return value

int|WP_Error

The post ID on success. The value 0 or WP_Error on failure.

Performance profile

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

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

17–105

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

31

31 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
• optionoption read or writeget_option()one call below wp_update_post()
• cacheobject cachewp_cache_add()one call below wp_update_post()
• hookthird-party callbacksapply_filters()one call below wp_update_post()

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

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

Uses · 11

• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• get_post()Retrieves post data given a post ID or post object.
• __()Retrieves the translation of $text.
• current_time()Retrieves the current time based on specified type.
• wp_insert_attachment()Inserts an attachment.
• is_object_in_taxonomy()Determines if the given object type is associated with the given taxonomy.
• get_the_terms()Retrieves the terms of the taxonomy that are attached to the post.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• wp_insert_post()Inserts or update a post.
• WP_Error::__construct()Initializes the error.

Used by · 31

• WP_Customize_Manager::save_changeset_post()Saves the post for the loaded changeset.
• WP_Customize_Nav_Menus::save_nav_menus_created_posts()Publishes the auto-draft posts that were created for nav menu items.
• WP_Embed::shortcode()The do_shortcode() callback function.
• WP_REST_Autosaves_Controller::create_item()Creates, updates or deletes an autosave revision.
• WP_REST_Autosaves_Controller::create_post_autosave()Creates autosave for the specified post.
• WP_REST_Posts_Controller::update_item()Updates a single post.
• WP_REST_Templates_Controller::update_item()Updates a single template.
• _fix_attachment_links()Replaces hrefs of attachment anchors with up-to-date permalinks.
• _wp_personal_data_cleanup_requests()Cleans up failed and expired requests before displaying the list table.
• _wp_privacy_account_request_confirmed()Updates log when privacy request is confirmed.
• _wp_privacy_completed_request()Marks a request as completed by the admin and logs the current timestamp.
• bulk_edit_posts()Processes the post data for the bulk editing of posts.

Source code

View on Trac ↗View on GitHub ↗

5147function wp_update_post( $postarr = array(), $wp_error = false, $fire_after_hooks = true ) {5148	if ( is_object( $postarr ) ) {5149		// Non-escaped post was passed.5150		$postarr = get_object_vars( $postarr );5151		$postarr = wp_slash( $postarr );5152	}5153 5154	// First, get all of the original fields.5155	$post = get_post( $postarr['ID'], ARRAY_A );5156 5157	if ( is_null( $post ) ) {5158		if ( $wp_error ) {5159			return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) );5160		}5161		return 0;5162	}5163 5164	// Escape data pulled from DB.5165	$post = wp_slash( $post );5166 5167	// Passed post category list overwrites existing category list if not empty.5168	if ( isset( $postarr['post_category'] ) && is_array( $postarr['post_category'] )5169		&& count( $postarr['post_category'] ) > 05170	) {5171		$post_cats = $postarr['post_category'];5172	} else {5173		$post_cats = $post['post_category'];5174	}5175 5176	// Drafts shouldn't be assigned a date unless explicitly done so by the user.5177	if ( isset( $post['post_status'] )5178		&& in_array( $post['post_status'], array( 'draft', 'pending', 'auto-draft' ), true )5179		&& empty( $postarr['edit_date'] ) && ( '0000-00-00 00:00:00' === $post['post_date_gmt'] )5180	) {5181		$clear_date = true;5182	} else {5183		$clear_date = false;5184	}5185 5186	// Merge old and new fields with new fields overwriting old ones.5187	$postarr                  = array_merge( $post, $postarr );5188	$postarr['post_category'] = $post_cats;5189	if ( $clear_date ) {5190		$postarr['post_date']     = current_time( 'mysql' );5191		$postarr['post_date_gmt'] = '';5192	}5193 5194	if ( 'attachment' === $postarr['post_type'] ) {5195		return wp_insert_attachment( $postarr, false, 0, $wp_error );5196	}5197 5198	// Discard 'tags_input' parameter if it's the same as existing post tags.5199	if ( isset( $postarr['tags_input'] ) && is_object_in_taxonomy( $postarr['post_type'], 'post_tag' ) ) {5200		$tags      = get_the_terms( $postarr['ID'], 'post_tag' );5201		$tag_names = array();5202 5203		if ( $tags && ! is_wp_error( $tags ) ) {5204			$tag_names = wp_list_pluck( $tags, 'name' );5205		}5206 5207		if ( $postarr['tags_input'] === $tag_names ) {5208			unset( $postarr['tags_input'] );5209		}5210	}5211 5212	return wp_insert_post( $postarr, $wp_error, $fire_after_hooks );5213}

Changelog

Introduced in 1.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/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.