当前浏览:首页 / WordPress函数 / update_metadata()

update_metadata( string $meta_type, int $object_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ): int|bool

更新指定对象的元数据,如果指定的对象ID和元数据键没有值,则将添加元数据

metadatamore...

updatemore...


参数

$meta_typestring必填
对象元数据的类型为,接受'post''comment''term''user'或任何其他具有关联meta表的对象类型。
$object_idint必填
对象ID
$meta_keystring必填
元数据键
$meta_valuemixed必填
元数据值,如果非标量,则必须可序列化。
$prev_valuemixed可选
更新前要检查的上一个值。
如果已指定,则仅使用此值更新现有元数据条目。否则,更新所有条目。

默认:''


返回

int|bool 如果具有给定键的字段不存在并因此被添加,则为新的元字段ID;如果更新成功,则为true;如果失败,则为false;如果传递给函数的值与数据库中已有的值相同,则为false。


钩子

do_action( 'updated_postmeta', int $meta_id, int $object_id, string $meta_key, mixed $meta_value )

更新文章元数据后立即触发。

do_action( "updated_{$meta_type}_meta", int $meta_id, int $object_id, string $meta_key, mixed $_meta_value )

更新特定类型的元数据后立即触发。

do_action( 'update_postmeta', int $meta_id, int $object_id, string $meta_key, mixed $meta_value )

在更新文章的元数据之前立即触发。

do_action( "update_{$meta_type}_meta", int $meta_id, int $object_id, string $meta_key, mixed $_meta_value )

在更新特定类型的元数据之前立即触发。

apply_filters( "update_{$meta_type}_metadata", null|bool $check, int $object_id, string $meta_key, mixed $meta_value, mixed $prev_value )

短路更新特定类型的元数据。



源码

查看源码 官方文档


更新日志

版本描述
2.9.0开始引入