get_post_field() – Retrieve data from a post field based on Post ID.

You appear to be a bot. Output may be restricted

Description

Retrieve data from a post field based on Post ID.

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.

Usage

$string = get_post_field( $field, $post, $context );

Parameters

$field
( string ) required – Post field name.
$post
( int|WP_Post ) optional – Optional. Post ID or post object. Defaults to global $post.
$context
( string ) optional default: display – Optional. How to filter the field. Accepts 'raw', 'edit', 'db', or 'display'. Default 'display'.

Returns

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

Source

File name: wordpress/wp-includes/post.php
Lines:

1 to 13 of 13
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 );
}
 

 View on GitHub View on Trac