Codex

Codex Resources

Function Reference/get post meta

Contents

Description

This function returns the values of the custom fields with the specified key from the specified post. See also update_post_meta(), delete_post_meta() and add_post_meta().

Usage

 <?php $meta_values = get_post_meta($post_id, $key, $single); ?> 

Examples

Default Usage

<?php $key_1_values = get_post_meta(76, 'key_1'); ?>

Other Example

To retrieve only the first value of a given key: 

<?php $key_1_value = get_post_meta(76, 'key_1', true); ?>

For a more detailed example, go to the post_meta Functions Examples page.

Parameters

$post_id
(integer) (required) The ID of the post from which you want the data. Use $post->ID to get a post's ID.
Default: None
$key
(string) (required) A string containing the name of the meta value you want.
Default: None
$single
(boolean) (optional) If set to true then the function will return a single result, as a string. If false, or not set, then the function returns an array of the custom fields.
Default: false

Return

  • If $single is set to false, or left blank, the function returns an array containing all values of the specified key.
  • If $single is set to true, the function returns the first value of the specified key (not in an array)

Related

update_post_meta(), delete_post_meta(), add_post_meta(), get_post_custom(), get_post_custom_values(), get_post_custom_keys()

Retrieved from "http://codex.wordpress.org/Function_Reference/get_post_meta"