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

add_metadata( string $meta_type, int $object_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false

为指定对象添加元数据

addmore...

metadatamore...


参数

$meta_typestring必填
对象元数据的类型,接受'post''comment''term''user'或任何其他具有关联meta表的对象类型。
$object_idint必填
对象ID
$meta_keystring必填
元数据键。
$meta_valuemixed必填
元数据值,如果非标量,则必须可序列化。
$uniquebool可选
指定的元数据键对于对象是否应唯一。
如果为true,并且对象已经具有指定元数据键的值,则不会进行任何更改。

默认:false


返回

int|false 成功时为meta ID,失败时为false。


钩子



源码

查看源码 官方文档


更新日志

版本描述
2.9.0开始引入

使用示例

  • 示例1

    例子:

    为评论添加额外的元值,这里的元键是location,$location变量保存其值。

    function add_comment_location($comment_id, $location) {
    	return add_metadata( 'comment', $comment_id, 'location', wp_slash( $location ) );
    }