get_post_custom_values( string $key = '', int $post_id )

Retrieve values for a custom post field.


Description Description

The parameters must not be considered optional. All of the post meta fields will be retrieved and only the meta field key values returned.


Parameters Parameters

$key

(string) (Optional) Meta field key.

Default value: ''

$post_id

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


Top ↑

Return Return

(array|null) Meta field values.


Top ↑

Source Source

File: wp-includes/post.php

function get_post_custom_values( $key = '', $post_id = 0 ) {
	if ( !$key )
		return null;

	$custom = get_post_custom($post_id);

	return isset($custom[$key]) ? $custom[$key] : null;
}

Top ↑

Changelog Changelog

Changelog
Version Description
1.2.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    Contributed by Codex

    Default usage example.

    Let’s assume the current post has 3 values associated with the (custom) field my_key.

    You could show them through:

    $mykey_values = get_post_custom_values( 'my_key' );
    
    foreach ( $mykey_values as $key => $value ) {
    	echo "$key => $value ( 'my_key' )<br />"; 
    }
    

    The above example will output:

    0 => First value ( 'my_key' )
    1 => Second value ( 'my_key' )
    2 => Third value ( 'my_key' )
    

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