WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_post_custom_values()

get_post_custom_values( string $key = '', int $post_id ): array|null

In this article

Back to top

Retrieves values for a custom post field.

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

$keystringoptional
Meta field key.

Default:''

$post_idintoptional
Post ID. Default is the ID of the global $post.

Return

array|null Meta field values.

Source

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;
}

View all references View on Trac View on GitHub

UsesDescription
get_post_custom()wp-includes/post.php

Retrieves post meta fields, based on post ID.

Used byDescription
the_meta()wp-includes/post-template.php

Displays a list of post custom fields.

Changelog

VersionDescription
1.2.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Codex
    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

    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.