get_post_field() – Function | Developer.WordPress.org

Retrieves data from a post field based on Post ID.

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.

Parameters

$fieldstringrequired: Post field name.
$postint|WP_Postoptional: Post ID or post object. Defaults to global $post.
Default:null
$contextstringoptional: How to filter the field. Accepts 'raw', 'edit', 'db', or 'display'. Default 'display'.
Default:'display'

Return

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

Source

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 all references View on Trac View on GitHub

Uses	Description
sanitize_post_field()`wp-includes/post.php`	Sanitizes a post field based on context.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Used by	Description
_wp_translate_postdata()`wp-admin/includes/post.php`	Renames `$_POST` data from form names to DB post columns.
wp_insert_post()`wp-includes/post.php`	Inserts or update a post.
wp_update_nav_menu_item()`wp-includes/nav-menu.php`	Saves the properties of a menu item or create a new one.

Changelog

Version	Description
4.5.0	The `$post` parameter was made optional.
2.3.0	Introduced.

User Contributed Notes

Andrei Surdu 6 years ago

Here are the default post fields that you can get (case-sensitive):

ID
post_author
post_date
post_date_gmt
post_content
post_title
post_excerpt
post_status
comment_status
ping_status
post_password
post_name
to_ping
pinged
post_modified
post_modified_gmt
post_content_filtered
post_parent
guid
menu_order
post_type
post_mime_type
comment_count
filter

Skip to note 6 content

Andrei Surdu 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
The $field parameter is case sensitive. Example:
```
get_post_field('ID'); // Returns an integer value which is the current post ID. Ex: `1035`
get_post_field('id'); // Returns an empty string.
```
Log in to add feedback
Skip to note 7 content

Uriahs Victor 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Get the author of a post outside the loop:
```
$author_id = get_post_field( 'post_author', $post_id );
$author    = get_the_author_meta( 'display_name', $author_id );</code>
```
Log in to add feedback
Skip to note 8 content

BigupJeff 3 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Here is a simple one-liner to get a formatted first line of the written post content. Useful for meta page description (demo’d here), excerpts and the like.
```
$description = ucfirst( preg_split('/[.?!]/',  wp_strip_all_tags( get_post_field( 'post_content', '' ), true ), 2, )[0] ) . '.';
echo <<<EOF
<meta name="description" content="$description">
EOF;
```
Breakdown:

ucfirst( $mystring )
PHP Function: Uppercase the first character (Eng sentence case).

preg_split('/[.?!]/', $mystring , 2, )
PHP Function: Split string at regex defined chars, limit to n chunks (could return more than one sentence).

wp_strip_all_tags( $myhtml , true )
WP Function: Get the HTML gone, bool: remove breaks.

get_post_field( 'post_content', '' )
WP Function: Get the post content.

. '.'
Notice I append a “.” as preg_split disposes of the target char. If you require the actual punctuation, e.g “!?” you will need to expand this.
Log in to add feedback

get_post_field( string $field, int|WP_Post $post = null, string $context = ‘display’ ): string

In this article