Question

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

Retrieve 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.

---

参数

$field

(string) (Required) Post field name.

$post

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

Default value: null

$context

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

Default value: 'display'

---

返回值

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

---

源代码

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);
}

---

更新日志

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

---

相关函数

Uses

• wp-includes/post.php: sanitize_post_field()
• wp-includes/post.php: get_post()

---

Used By

• wp-admin/includes/post.php: _wp_translate_postdata()
• wp-includes/post.php: wp_insert_post()
• wp-includes/nav-menu.php: wp_update_nav_menu_item()

---

User Contributed Notes