関数の概要
update_post_meta()
は、WordPressで特定の投稿に関連するメタデータ(カスタムフィールド)の値を更新するための関数です。指定したキーに対するメタデータが既に存在する場合はその値を更新し、存在しない場合は新しいメタデータを追加します。この関数は、投稿に関連するカスタム情報を動的に変更する際に非常に便利です。
パラメータの説明
update_post_meta()
関数は4つのパラメータを受け取ります。
$post_id
(int, 必須): メタデータを更新する投稿のID。$meta_key
(string, 必須): 更新するメタデータのキー。$meta_value
(mixed, 必須): 新しいメタデータの値。$prev_value
(mixed, オプション): 更新する前の値。指定した場合、この値と一致するメタデータだけが更新されます。
使用例
以下は、update_post_meta()
関数を使用して投稿のメタデータを更新する例です。
<?php
// 投稿IDが42の投稿のカスタムフィールド 'subtitle' の値を 'New Subtitle' に更新する
$post_id = 42;
$meta_key = 'subtitle';
$meta_value = 'New Subtitle';
if (update_post_meta($post_id, $meta_key, $meta_value)) {
echo '<p>Subtitle updated successfully.</p>';
} else {
echo '<p>Subtitle update failed.</p>';
}
// 投稿IDが42の投稿のカスタムフィールド 'subtitle' の値を 'Old Subtitle' から 'New Subtitle' に更新する
$prev_value = 'Old Subtitle';
if (update_post_meta($post_id, $meta_key, $meta_value, $prev_value)) {
echo '<p>Subtitle updated successfully from "Old Subtitle" to "New Subtitle".</p>';
} else {
echo '<p>Subtitle update failed.</p>';
}
?>
関連する関数
add_post_meta()
: 投稿に新しいメタデータを追加します。キーと値のペアを追加します。get_post_meta()
: 投稿のメタデータを取得します。特定のキーの値を取得します。delete_post_meta()
: 投稿からメタデータを削除します。特定のキーのメタデータを削除します。get_metadata()
: 汎用的なメタデータ取得関数で、投稿以外のメタデータにも使用できます。update_metadata()
: 汎用的なメタデータ更新関数で、投稿以外のメタデータにも使用できます。update_term_meta()
: 用語(ターム)のメタデータを更新します。update_user_meta()
: ユーザーのメタデータを更新します。