関数の概要
add_post_meta()
は、WordPressで特定の投稿に新しいメタデータ(カスタムフィールド)を追加するための関数です。メタデータは、投稿に追加の情報を提供するために使用されるキーと値のペアです。この関数は、投稿に新しいカスタム情報を保存する際に非常に便利です。
パラメータの説明
add_post_meta()
関数は4つのパラメータを受け取ります。
$post_id
(int, 必須): メタデータを追加する投稿のID。$meta_key
(string, 必須): 追加するメタデータのキー。$meta_value
(mixed, 必須): 追加するメタデータの値。$unique
(bool, オプション): trueに設定すると、同じキーのメタデータが既に存在する場合、新しいメタデータは追加されません。デフォルトはfalseです。
使用例
以下は、add_post_meta()
関数を使用して投稿にメタデータを追加する例です。
<?php
// 投稿IDが42の投稿にカスタムフィールド 'subtitle' を追加し、その値を 'My Subtitle' に設定する
$post_id = 42;
$meta_key = 'subtitle';
$meta_value = 'My Subtitle';
if (add_post_meta($post_id, $meta_key, $meta_value, true)) {
echo '<p>Subtitle meta data added successfully.</p>';
} else {
echo '<p>Subtitle meta data addition failed or already exists.</p>';
}
// 同じキーのメタデータが既に存在する場合でも追加する
if (add_post_meta($post_id, $meta_key, 'Another Subtitle')) {
echo '<p>Another subtitle meta data added successfully.</p>';
} else {
echo '<p>Another subtitle meta data addition failed.</p>';
}
?>
関連する関数
get_post_meta()
: 投稿のメタデータを取得します。特定のキーの値を取得します。update_post_meta()
: 既存のメタデータの値を更新します。キーと値のペアを更新します。delete_post_meta()
: 投稿からメタデータを削除します。特定のキーのメタデータを削除します。add_metadata()
: 汎用的なメタデータ追加関数で、投稿以外のメタデータにも使用できます。add_term_meta()
: 用語(ターム)のメタデータを追加します。add_user_meta()
: ユーザーのメタデータを追加します。