get_post_meta( int $post_id, string $key = '', bool $single = false )

Retrieves a post meta field for the given post ID.

Parameters

$post_id

(Required) Post ID.

$key

(Optional) The meta key to retrieve. By default, returns data for all keys.

Default value: ''

$single

(Optional) Whether to return a single value.<br> This parameter has no effect if $key is not specified.<br>

Default value: false

Return

(mixed) An array of values if $single is false.<br> The value of the meta field if $single is true.<br> False for an invalid $post_id (non-numeric, zero, or negative value).<br> An empty string if a valid but non-existing post ID is passed.

Source

File: wp-includes/post.php 

function get_post_meta( $post_id, $key = '', $single = false ) {
	return get_metadata('post', $post_id, $key, $single);
}

Expand Source Code View on GitHub

Changelog

Changelog
Version Description
1.5.0 Introduced.