wpseek.com
A WordPress-centric search engine for devs and theme authors



add_post_meta › WordPress Function

Since1.5.0
Deprecatedn/a
› add_post_meta ( $post_id, $meta_key, $meta_value, $unique = false )
Parameters: (4)
  • (int) $post_id Post ID.
    Required: Yes
  • (string) $meta_key Metadata name.
    Required: Yes
  • (mixed) $meta_value Metadata value. Arrays and objects are stored as serialized data and will be returned as the same type when retrieved. Other data types will be stored as strings in the database: - false is stored and retrieved as an empty string ('') - true is stored and retrieved as '1' - numbers (both integer and float) are stored and retrieved as strings Must be serializable if non-scalar.
    Required: Yes
  • (bool) $unique Optional. Whether the same key should not be added. Default false.
    Required: No
    Default: false
Returns:
  • (int|false) Meta ID on success, false on failure.
Defined at:
Codex:

Adds a meta field to the given post.

Post meta data is called "Custom Fields" on the Administration Screen.


Related Functions: add_site_meta, add_term_meta, get_post_meta, add_user_meta, wp_add_post_tags

Source 

function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) {
	// 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 add_metadata( 'post', $post_id, $meta_key, $meta_value, $unique );
}