get_post_custom( int $post_id )

Retrieve post meta fields, based on post ID.

Contents

Description Description

The post meta fields are retrieved from the cache where possible, so the function is optimized to be called more than once.

Parameters Parameters

$post_id

(int) (Optional) Post ID. Default is ID of the global $post.

Top ↑

Return Return

(array) Post meta for the given post.

Top ↑

Source Source

File: wp-includes/post.php 

function get_post_custom( $post_id = 0 ) {
	$post_id = absint( $post_id );
	if ( ! $post_id ) {
		$post_id = get_the_ID();
	}

	return get_post_meta( $post_id );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.2.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/functions.php: absint()

Convert a value to non-negative integer.
wp-includes/post-template.php: get_the_ID()

Retrieve the ID of the current item in the WordPress Loop.
wp-includes/post.php: get_post_meta()

Retrieves a post meta field for the given post ID.

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/feed.php: rss_enclosure()

Display the rss enclosure for the current post.
wp-includes/feed.php: atom_enclosure()

Display the atom enclosure for the current post.
wp-includes/post-template.php: post_custom()

Retrieve post custom meta data field.
wp-includes/post.php: get_enclosed()

Retrieve enclosures already enclosed for a post.
wp-includes/post.php: get_post_custom_keys()

Retrieve meta field names for a post.
wp-includes/post.php: get_post_custom_values()

Retrieve values for a custom post field.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getPost()

Retrieve post.
Show 2 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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.

You must log in before being able to contribute a note or feedback.