get_post_field( string $field, int|WP_Post $post = null, string $context = 'display' )
Retrieve data from a post field based on Post ID.
Contents
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
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'
Return Return
(string) The value of the post field on success, empty string on failure.
Source Source
File: wp-includes/post.php
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 );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 4.5.0 | The $post parameter was made optional. |
| 2.3.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Here are the default post fields that you can get (case-sensitive):
Expand full source codeCollapse full source code
The
$fieldparameter 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.Get the author of a post outside the loop: