関数リファレンス/get post meta

目次 1 概要 2 使用法 3 パラメータ 4 戻り値 5 使用例 5.1 デフォルトでの使用 5.2 その他の例

概要

この関数は特定の投稿と特定のキーからカスタムフィールドの値を取得します。update_post_meta()やdelete_post_meta()、add_post_meta()も見てみてください。

使用法

<?php $meta_values = get_post_meta($post_id, $key, $single); ?>

パラメータ

$post_id

（integer） （必須） データを取得したい投稿のID。投稿のIDを取得するには$post->IDを使うこと。

初期値： なし

$key

（string） （必須） 取得したい値のキー名の文字列。

初期値： なし

$single

（boolean） （オプション） trueにセットした場合、文字列として単一の結果を返します。falseの場合、関数はカスタムフィールドの配列を返します。これはあまり直感的ではありません。たとえば、このメソッドでシリアル化された配列を取得した場合、$singleをtrueに設定するとアンシリアル化された配列が戻ってきます。falseを設定するか何も設定しなかった場合、一つの要素からなる配列が帰ってきて、インデックス0の値はシリアル化された文字列となります。

初期値： false

戻り値

• $singleがfalseに設定されているか、何も設定しなかった場合、関数は指定したキーを持つ値からなる配列を返します。
• $singleがtrueに設定された場合、関数は指定されたキーを持つ最初の値を返します（配列ではありません）。

この関数は$singleの値に関わらず、キーが見つからなかったら空の文字列を返します。

使用例

デフォルトでの使用

 <?php $key_1_values = get_post_meta(76, 'key_1'); ?>

その他の例

与えられたキーの最初の値だけを取得する:

 <php $key_1_value = get_post_meta(76, 'key_1', true); ?>

より詳しい例については、post_meta 関数の例のページへ行ってください。