get_post_field( string $field, int|WP_Post $post = null, string $context = 'display' ): int|string|int[]

Description

Parameters

$fieldstring

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

int|string|int[]

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

Uses · 2

• get_post()Retrieves post data given a post ID or post object.
• sanitize_post_field()Sanitizes a post field based on context.

Used by · 7

• _wp_translate_postdata()Renames `$_POST` data from form names to DB post columns.
• render_block_core_avatar()Renders the `core/avatar` block on the server.
• render_block_core_post_author()Renders the `core/post-author` block on the server.
• render_block_core_post_author_biography()Renders the `core/post-author-biography` block on the server.
• render_block_core_post_author_name()Renders the `core/post-author-name` block on the server.
• wp_insert_post()Inserts or updates a post in the database.
• wp_update_nav_menu_item()Saves the properties of a menu item or create a new one.

Source

View on Trac ↗View on GitHub ↗

1206function get_post_field( $field, $post = null, $context = 'display' ) {1207	$post = get_post( $post );1208 1209	if ( ! $post ) {1210		return '';1211	}1212 1213	if ( ! isset( $post->$field ) ) {1214		return '';1215	}1216 1217	return sanitize_post_field( $field, $post->$field, $post->ID, $context );1218}

History

Introduced in 2.3.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.