get_post_custom_keys( int $post_id ): array|void

Retrieves meta field names for a post.

Description

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

Parameters

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

Return

array|void Array of the keys, if retrieved.

Source

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

View all references View on Trac View on GitHub

Uses	Description
get_post_custom()`wp-includes/post.php`	Retrieves post meta fields, based on post ID.

Used by	Description
the_meta()`wp-includes/post-template.php`	Displays a list of post custom fields.
WP_Embed::delete_oembed_caches()`wp-includes/class-wp-embed.php`	Deletes all oEmbed caches. Unused by core as of 4.0.0.

Changelog

Version	Description
1.2.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 11 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Default Usage
The following example will set a variable ($custom_field_keys) as an array containing the keys of all custom fields in the current post, and then print it. Note: the if test excludes values for WordPress internally maintained custom keys such as _edit_last and _edit_lock.
```
<?php

$custom_field_keys = get_post_custom_keys();
foreach ( $custom_field_keys as $key => $value ) {
    $valuet = trim($value);
    if ( '_' == $valuet{0} )
        continue;
    echo $key . " => " . $value . "<br />";
}
?>
```
If the post contains custom fields with the keys mykey and yourkey, the output would be something like:
```
0 => mykey
1 => yourkey
```
Note: Regardless of how many values (custom fields) are assigned to one key, that key will only appear once in this array.
Log in to add feedback

You must log in before being able to contribute a note or feedback.