get_post_custom_values() WordPress Function

The get_post_custom_values() function allows you to get the values of custom fields for a given post. Custom fields are a way to add extra data to a post, and they are set up by the user in the administration area. The function takes two parameters: the key of the custom field you want to get, and the post ID.

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

Retrieve 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.


Top ↑

Parameters

$key

(string)(Optional) Meta field key.

Default value: ''

$post_id

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


Top ↑

Return

(array|null) Meta field values.


Top ↑

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
VersionDescription
1.2.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More