get_post_custom( int $post_id = 0 ): array<string,

Description

Parameters

$post_idintoptional

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

Return

array<string,

array&lt;int, string&gt;&gt;|false Array of post meta values keyed by meta key, or false on failure. Post meta values will always be strings, even for values which would otherwise be retrieved individually as arrays or objects via get_post_meta(). An empty array is returned if the post has no post meta.

Uses · 3

• absint()Converts a value to non-negative integer.
• get_the_ID()Retrieves the ID of the current item in the WordPress Loop.
• get_post_meta()Retrieves a post meta field for the given post ID.

Used by · 7

• atom_enclosure()Displays the atom enclosure for the current post.
• get_enclosed()Retrieves enclosures already enclosed for a post.
• get_post_custom_keys()Retrieves meta field names for a post.
• get_post_custom_values()Retrieves values for a custom post field.
• post_custom()Retrieves post custom meta data field.
• rss_enclosure()Displays the rss enclosure for the current post.
• wp_xmlrpc_server::mw_getPost()Retrieves a post.

Source

View on Trac ↗View on GitHub ↗

2848function get_post_custom( $post_id = 0 ) {2849	$post_id = absint( $post_id );2850 2851	if ( ! $post_id ) {2852		$post_id = get_the_ID();2853	}2854 2855	return get_post_meta( $post_id );2856}

History

Introduced in 1.2.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.