get_post_field()

You are here:

get_post_field( string $fieldint|WP_Post $post = nullstring $context = ‘display’ )

Retrieve data from a post field based on Post ID.

Description Description

Examples of the post field will be, ‘post_type’, ‘post_status’, ‘post_content’, etc and based off of the post object property or key names.

The context values are based off of the taxonomy filter functions and supported values are found within those functions.

See also See also

  • sanitize_post_field()

Top ↑

Parameters Parameters

$field

(string) (Required) Post field name.

$post

(int|WP_Post) (Optional) Post ID or post object. Defaults to global $post.

Default value: null

$context

(string) (Optional) How to filter the field. Accepts ‘raw’, ‘edit’, ‘db’, or ‘display’.

Default value: ‘display’


Top ↑

Return Return

(string) The value of the post field on success, empty string on failure.


Top ↑

Source Source

File: wp-includes/post.php

851
852
853
854
855
856
857
858
859
860
861
862
863
function get_post_field( $field, $post = null, $context = 'display' ) {
    $post = get_post( $post );
 
    if ( ! $post ) {
        return '';
    }
 
    if ( ! isset( $post->$field ) ) {
        return '';
    }
 
    return sanitize_post_field( $field, $post->$field, $post->ID, $context );
}


Top ↑

Changelog Changelog

Changelog
VersionDescription
4.5.0The $post parameter was made optional.
2.3.0Introduced.
Was this article helpful?
Dislike 1
Views: 3

Cart

Log in

Create an Account
Back to Top