WordPress.org

Ready to get started?Download WordPress

Codex

Function Reference/get post custom

Contents

Description

Returns a multidimensional array with all custom fields of a particular post or page. See also get_post_custom_keys() and get_post_custom_values()

Usage

 <?php get_post_custom($post_id); ?> 

Parameters

$post_id
(integer) (optional) The post ID whose custom fields will be retrieved.
Default: Current post

Examples

Default Usage

Use the following example to set a variable ($custom_fields) as a multidimensional array containing all custom fields of the current post.

<?php $custom_fields = get_post_custom(); ?>

Retrieving data from the array

The following example will retrieve all custom field values with the key my_custom_field from post ID 72 (assuming there are three custom fields with this key, and the values are "dogs", "47" and "This is another value").

<?php

  $custom_fields = get_post_custom(72);
  $my_custom_field = $custom_fields['my_custom_field'];
  foreach ( $my_custom_field as $key => $value ) {
    echo $key . " => " . $value . "<br />";
  }

?>

0 => dogs
1 => 47
2 => This is another value

Note: not only does the function return a multi-dimensional array (ie: always be prepared to deal with an array of arrays, even if expecting array of single values), but it also returns serialized values of any arrays stored as meta values. If you expect that possibly an array may be stored as a metavalue, then be prepared to maybe_unserialize.

Source Code

get_post_custom() is located in wp-includes/post.php

Changelog

Related

Custom Fields: the_meta(), get_post_meta(), add_post_meta(), update_post_meta(), delete_post_meta(), get_post_custom(), get_post_custom_values(), get_post_custom_keys() (See Also: post_meta Function Examples)

See also index of Function Reference and index of Template Tags.