函数原型
get_post_meta( int $post_id, string $key = ”, bool $single = false ): mixed
函数描述
Retrieves a post meta field for the given post ID.
是否弃用
未弃用
函数参数
-
$post_id
int
Required - Post ID.
-
$key
string
Optional - The meta key to retrieve. By default, returns data for all keys.
Default:
'' -
$single
bool
Optional - Whether to return a single value.
This parameter has no effect if$keyis not specified.
Default:
false
函数返回值
mixed An array of values if $single is false.
The value of the meta field if $single is true.
False for an invalid $post_id (non-numeric, zero, or negative value).
An empty string if a valid but non-existing post ID is passed.
函数位置
File: wp-includes/post.php.
函数源码
function get_post_meta( $post_id, $key = '', $single = false ) {
return get_metadata( 'post', $post_id, $key, $single );
}
源码链接
变更日志
| Version | Description |
|---|---|
| 1.5.0 | Introduced. |
