A WordPress-centric search engine for devs and theme authors



update_post_meta ›

Since1.5.0
Deprecatedn/a
update_post_meta ( $post_id, $meta_key, $meta_value, $prev_value = '' )
Parameters: (4)
  • (int) $post_id Post ID.
    Required: Yes
  • (string) $meta_key Metadata key.
    Required: Yes
  • (mixed) $meta_value Metadata value. Must be serializable if non-scalar.
    Required: Yes
  • (mixed) $prev_value Optional. Previous value to check before updating.
    Required: No
    Default: (empty)
Returns:
  • (int|bool) The new meta field ID if a field with the given key didn't exist and was therefore added, true on successful update, false on failure.
Defined at:
Codex:

Updates a post meta field based on the given post ID.

Use the $prev_value parameter to differentiate between meta fields with the same key and post ID.

If the meta field for the post does not exist, it will be added and its ID returned.



Source

function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
	// Make sure meta is added to the post, not a revision.
	$the_post = wp_is_post_revision( $post_id );
	if ( $the_post ) {
		$post_id = $the_post;
	}

	return update_metadata( 'post', $post_id, $meta_key, $meta_value, $prev_value );
}