update_metadata

パラメータ

• $meta_type
  オブジェクトタイプとして'post'、'comment'、'term'、'user'のいずれかを指定。
• $object_id
  関連するWordPressオブジェクトのIDを指定。
• $meta_key
  メタキーを指定。
• $meta_value
  メタ情報の値を指定。
• $prev_value
  更新前のメタ情報の値を指定（省略時は''）。

返り値

注意

本関数は投稿メタ（カスタムフィールド）やコメントメタなどのメタ情報を更新する場合に使用し、投稿メタを更新する update_post_meta関数や、ユーザーメタを更新する update_user_meta関数などから呼び出される。

[3.1.0]"update_{$meta_type}_metadata"フィルターのコールバック関数にてメタ情報の適切な処理を行い、null以外を返した場合は、以降の処理は行われず、返した値をboolでキャストしたものが本関数の返り値となる。

既存のメタ情報が存在しない場合は新しくメタ情報が登録され、その返り値はメタ情報のIDになるため、返り値をtrueかどうかを判定する場合は注意が必要である。また追加時は本関数内のいくつかのアクションは実行されない。

メタ情報の更新に失敗した場合、"updated_{$meta_type}_meta"アクションと'updated_postmeta'アクションは実行されない。

パラメータ$meta_typeが'post'の場合に実行される'update_postmeta'および'updated_postmeta'アクションの第4パラメータはシリアライズされた値になる。それぞれの直前に実行される'update_post_meta'および'updated_post_meta'アクションの第4パラメータとは異なるので要注意。

使用例

• カスタムフィールド'price'を更新する

  update_metadata( 'post', $post->ID, 'price', 100 );

フィルター

$check = apply_filters( "update_{$meta_type}_metadata", $check, $object_id, $meta_key, $meta_value, $prev_value );

アクション

do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );

do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );

do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );

do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );

ソースファイル