add_post_meta

Add meta data field to a post.

Description

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

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

Returns (int|false)

Meta ID on success, false on failure.

Parameters (4)

0. $post_id (int)
The post id.
1. $meta_key (string)
Metadata name.
2. $meta_value (mixed)
Metadata value. Must be serializable if non-scalar.
3. $unique — Optional. (bool) => false
Whether the same key should not be added. Default false.

Usage

  1. if ( !function_exists( 'add_post_meta' ) ) { 
  2.     require_once ABSPATH . WPINC . '/post.php'; 
  3. } 
  4.   
  5. // The post id. 
  6. $post_id = -1; 
  7.   
  8. // Metadata name. 
  9. $meta_key = ''; 
  10.   
  11. // Metadata value. Must be serializable if non-scalar. 
  12. $meta_value = null; 
  13.   
  14. // Optional. Whether the same key should not be added. 
  15. // Default false. 
  16. $unique = false; 
  17.   
  18. // NOTICE! Understand what this does before running. 
  19. $result = add_post_meta($post_id, $meta_key, $meta_value, $unique); 
  20.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/post.php  
  1. function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) { 
  2.     // Make sure meta is added to the post, not a revision. 
  3.     if ( $the_post = wp_is_post_revision($post_id) ) 
  4.         $post_id = $the_post; 
  5.  
  6.     return add_metadata('post', $post_id, $meta_key, $meta_value, $unique); 
  7. }