W3cubDocs

/WordPress

post_custom( string $key = '' )

Retrieve post custom meta data field.

Description

Parameters

$key

(string) (Optional) Meta data key name.

Default value: ''

Return

(false|string|array) Array of values or single value, if only one element exists. False will be returned if key does not exist.

Source

File: wp-includes/post-template.php

function post_custom( $key = '' ) {
	$custom = get_post_custom();

	if ( ! isset( $custom[ $key ] ) ) {
		return false;
	} elseif ( 1 == count( $custom[ $key ] ) ) {
		return $custom[ $key ][0];
	} else {
		return $custom[ $key ];
	}
}

Changelog

Version Description
1.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/post_custom