update_metadata

（2.9.0以降）
update_metadata - メタ情報を更新する

説明

bool | int update_metadata( string $meta_type, int $object_id, string $meta_key, mixed $meta_value [ , mixed $prev_value = '' ] )
WordPressオブジェクトのメタ情報を更新する。

パラメータ

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

返り値

メタ情報を更新できた場合はtrueを返す。該当するメタ情報が存在せず追加した場合はそのメタ情報IDを返す。それ以外の場合はfalseを返す。

注意

本関数は投稿メタ（カスタムフィールド）やコメントメタなどのメタ情報を更新する場合に使用し、投稿メタを更新する 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 );

フィルター

[3.1.0]メタ情報の更新（または追加）する前に"update_{$meta_type}_metadata"フィルターを呼び出す。パラメータ$checkにはnullが、$object_idには絶対値処理されたオブジェクトIDが、$meta_keyと$prev_valueには本関数が受け取った内容が、$meta_valueにはサニタイズした内容が格納されている。 
$check = apply_filters( "update_{$meta_type}_metadata", $check, $object_id, $meta_key, $meta_value, $prev_value );

アクション

[2.9.0]メタ情報を更新する前に"update_{$meta_type}_meta"アクションを呼び出す。パラメータ$meta_idにはメタ情報IDが、$object_idには絶対値処理されたオブジェクトIDが、$meta_keyには本関数が受け取った内容が、$_meta_valueにはシリアライズされていない値が格納されている。 
do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
[2.9.0]パラメータ$meta_typeが'post'の場合、メタ情報を更新する前に'update_postmeta'アクションを呼び出す。パラメータ$meta_idにはメタ情報IDが、$object_idには絶対値処理されたオブジェクトIDが、$meta_keyには本関数が受け取った内容が、$meta_valueにはシリアライズされた値が格納されている。 
do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
[2.9.0]メタ情報を更新した後に"updated_{$meta_type}_meta"アクションを呼び出す。パラメータ$meta_idにはメタ情報IDが、$object_idには絶対値処理されたオブジェクトIDが、$meta_keyには本関数が受け取った内容が、$_meta_valueにはシリアライズされていない値が格納されている。 
do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
[2.9.0]パラメータ$meta_typeが'post'の場合、メタ情報を更新した後に'updated_postmeta'アクションを呼び出す。パラメータ$meta_idにはメタ情報IDが、$object_idには絶対値処理されたオブジェクトIDが、$meta_keyには本関数が受け取った内容が、$meta_valueにはシリアライズされた値が格納されている。 
do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );

ソースファイル

/wp-includes/meta.php

最終更新 : 2024年06月25日 15:44

関連

参考

Code Reference: update_metadata

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。