函数原型
get_metadata( string $meta_type, int $object_id, string $meta_key = ”, bool $single = false ): mixed
函数描述
Retrieves the value of a metadata field for the specified object type and ID.
是否弃用
未弃用
函数参数
-
$meta_type
string
Required - Type of object metadata is for. Accepts
'post','comment','term','user', or any other object type with an associated meta table. -
$object_id
int
Required - ID of the object metadata is for.
-
$meta_key
string
Optional - Metadata key. If not specified, retrieve all metadata for the specified object.
Default:
'' -
$single
bool
Optional - If true, return only the first value of the specified
$meta_key.
This parameter has no effect if$meta_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 $object_id (non-numeric, zero, or negative value), or if $meta_type is not specified.
An empty string if a valid but non-existing object ID is passed.
函数位置
File: wp-includes/meta.php.
函数源码
function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
$value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single );
if ( ! is_null( $value ) ) {
return $value;
}
return get_metadata_default( $meta_type, $object_id, $meta_key, $single );
}
源码链接
变更日志
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |

