Home » Functions » get_post_custom

Function Name: get_post_custom

Explanation: The get_post_custom function in WordPress is used to retrieve the custom field values associated with a specific post. Custom fields, also known as post meta, allow you to add additional data to your posts or pages. This function returns an associative array containing all the custom field values for a given post.

Usage: To use the get_post_custom function, you need to provide the post ID as a parameter. This ID can be obtained using the get_the_ID function or by passing the ID of the post directly. Here’s an example usage code:

$post_id = get_the_ID(); // Get the ID of the current post
$custom_fields = get_post_custom($post_id); // Retrieve the custom fields for the post

// Accessing and displaying the custom field values
foreach ($custom_fields as $key => $value) {
    echo $key . ': ' . $value[0] . '<br>';

In this example, we first get the ID of the current post using the get_the_ID function. Then, we pass this ID to the get_post_custom function to retrieve all the custom field values associated with that post. We store the result in the $custom_fields variable.

To access and display the custom field values, we use a foreach loop to iterate through the $custom_fields array. Each custom field value is stored as an array element, where the key is the field name and the value is an array containing the field value(s). In this code snippet, we assume that each custom field has only one value, hence why we access it using $value[0]. Finally, we echo out the field name and its corresponding value.

By utilizing the get_post_custom function, you can easily retrieve and display custom field values within your WordPress templates or plugin development, allowing for dynamic content and enhanced functionality.

Learn More on

Register an account to save your snippets or go Pro to get more features.