get_post_meta()

関数の概要

get_post_meta()は、WordPressで特定の投稿に関連するメタデータ(カスタムフィールド)の値を取得するための関数です。メタデータは、投稿に追加の情報を提供するために使用されるキーと値のペアです。この関数は、投稿に関連するカスタム情報を表示する際に非常に便利です。

パラメータの説明

get_post_meta()関数は3つのパラメータを受け取ります。

  1. $post_id (int, 必須): メタデータを取得する投稿のID。
  2. $key (string, オプション): 取得するメタデータのキー。特定のキーを指定しない場合、すべてのメタデータが取得されます。
  3. $single (bool, オプション): trueの場合、単一のメタデータ値を返します。falseの場合、メタデータ値の配列を返します。デフォルトはfalseです。

使用例

以下は、get_post_meta()関数を使用して投稿のメタデータを取得し表示する例です。

<?php
// 投稿IDが42の投稿のカスタムフィールド 'subtitle' の値を取得する
$post_id = 42;
$subtitle = get_post_meta($post_id, 'subtitle', true);

if ($subtitle) {
    echo '<p>Subtitle: ' . esc_html($subtitle) . '</p>';
} else {
    echo '<p>No subtitle found for this post.</p>';
}

// 投稿IDが42の投稿のすべてのメタデータを取得する
$all_meta = get_post_meta($post_id);
echo '<pre>';
print_r($all_meta);
echo '</pre>';
?>

関連する関数

  • add_post_meta(): 投稿に新しいメタデータを追加します。
  • update_post_meta(): 既存のメタデータの値を更新します。
  • delete_post_meta(): 投稿からメタデータを削除します。
  • get_metadata(): 汎用的なメタデータ取得関数で、投稿以外のメタデータにも使用できます。
  • get_term_meta(): 用語(ターム)のメタデータを取得します。
  • get_user_meta(): ユーザーのメタデータを取得します。