- サイトデザイン工事中です。ご意見をお寄せください。
- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
関数リファレンス/update post meta
update post meta() は、指定した投稿に存在するカスタムフィールドの値を更新します。add_post_meta() の代わりとしても使うことができます。この関数はまず、$post_id で ID を指定した投稿に $meta_key を持つカスタムフィールドが存在することを確認します。もし存在しなければ代わりに add_post_meta($post_id, $meta_key, $meta_value) を実行し、その結果(常に true)を返します。
使い方
<?php update_post_meta($post_id, $meta_key, $meta_value, $prev_value); ?>
パラメータ
- $post_id
- (整数) (必須) 更新したいカスタムフィールドを持つ投稿の ID。
- 初期値: なし
- $meta_key
- (文字列) (必須) 更新したいカスタムフィールドのキー。
- 初期値: なし
- $meta_value
- (文字列) (必須) カスタムフィールドの新しい値。
- 初期値: なし
- $prev_value
- (文字列) (オプション) 更新したいカスタムフィールドの元の値。これは、同じキーを持つカスタムフィールドを区別するパラメータです。省略すると、指定したキーを持つカスタムフィールドはすべて値が更新されます。
- 初期値: なし
用例
デフォルトの使い方
ID が76の投稿で、キーが my_key のカスタムフィールドの値を Steve に変更します。
<?php update_post_meta(76, 'my_key', 'Steve'); ?>
その他の例
ID が76の投稿に、以下の4つのカスタムフィールドがある場合:
[key_1] => 'Happy'
[key_1] => 'Sad'
[key_2] => 'Gregory'
[my_key] => 'Steve'
key_2 のキーを持つカスタムフィールドの値を Hans に変更するには:
<?php update_post_meta(76, 'key_2', 'Hans'); ?>
key_1 のキーを持つカスタムフィールドで値を Sad から Happy に変更するには:
<?php update_post_meta(76, 'key_1', 'Happy', 'Sad'); ?>
この結果、カスタムフィールドは以下のようになります:
[key_1] => 'Happy'
[key_1] => 'Happy'
[key_2] => 'Hans'
[my_key] => 'Steve'
注: この関数は、条件に一致するすべてのカスタムフィールドを変更します。
始めの key_1 のキーを持つカスタムフィールドの値を Happy から Excited に変更するには:
<?php update_post_meta(76, 'key_1', 'Excited', 'Happy'); // または update_post_meta(76, 'key_1', 'Excited'); ?>
さらに詳しい例は post meta 関数の例 を見てください。
関連資料
カスタムフィールド: the_meta, get_post_meta, add_post_meta, update_post_meta, delete_post_meta, get_post_custom, get_post_custom_values, get_post_custom_keys (post_meta 関数の例も参照)
最新英語版: WordPress Codex » Function Reference/update post meta (最新版との差分)