get_post_custom_keys() WordPress Function

The get_post_custom_keys() function is used to get all the custom keys for a post. This is useful for getting all the data associated with a post, such as custom fields.

get_post_custom_keys( int $post_id ) #

Retrieve meta field names for a post.


Description

If there are no meta fields, then nothing (null) will be returned.


Top ↑

Parameters

$post_id

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


Top ↑

Return

(array|void) Array of the keys, if retrieved.


Top ↑

Source

File: wp-includes/post.php

function get_post_custom_keys( $post_id = 0 ) {
	$custom = get_post_custom( $post_id );

	if ( ! is_array( $custom ) ) {
		return;
	}

	$keys = array_keys( $custom );
	if ( $keys ) {
		return $keys;
	}
}


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