add_post_meta( int $post_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false

Description

Parameters

$post_idint

Post ID.

$meta_keystring

Metadata name.

$meta_valuemixed

Metadata value. Must be serializable if non-scalar.

$uniquebooloptional

Whether the same key should not be added. Default false.Default: false

Return

int|false

Meta ID on success, false on failure.

Uses · 2

• wp_is_post_revision()Determines if the specified post is a revision.
• add_metadata()Adds metadata for the specified object.

Used by · 18

• WP_Customize_Manager::trash_changeset_post()Trashes or deletes a changeset post.
• WP_Privacy_Policy_Content::_policy_page_updated()Updates the cached policy info when the policy page is updated.
• WP_Privacy_Policy_Content::get_suggested_policy_text()Checks for updated, added or removed privacy policy information from plugins.
• WP_REST_Font_Faces_Controller::create_item()Creates a font face for the parent font family.
• _publish_post_hook()Hook to schedule pings and enclosures when a post is published.
• add_meta()Adds post meta data defined in the `$_POST` superglobal for a post with given ID.
• do_enclose()Checks content for video and audio links to add as enclosures.
• media_sideload_image()Downloads an image from the specified URL, saves it as an attachment, and optionally attaches it to a post.
• wp_add_trashed_suffix_to_post_name_for_post()Adds a trashed suffix for a given post.
• wp_check_for_changed_dates()Checks for changed dates for published post objects and save the old date.
• wp_check_for_changed_slugs()Checks for changed slugs for published post objects and save the old slug.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.

Source

View on Trac ↗View on GitHub ↗

2562function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) {2563	// Make sure meta is added to the post, not a revision.2564	$the_post = wp_is_post_revision( $post_id );2565	if ( $the_post ) {2566		$post_id = $the_post;2567	}2568 2569	return add_metadata( 'post', $post_id, $meta_key, $meta_value, $unique );2570}

History

Introduced in 1.5.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.7.7 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.