acf_get_metadata()


WordPressのacf_get_metadata()関数は、Advanced Custom Fields(ACF)プラグインでカスタムフィールドのメタデータを取得するために使用されます。この関数は、投稿、ユーザー、ターム、オプションページなどのさまざまなコンテキストで動作します。

シンタックス

acf_get_metadata( int|string $id, string $name, bool $hidden = false );

引数の説明:

  • $id (int|string) — メタデータを取得する対象のIDまたは識別子。
  • $name (string) — メタデータのキー名。
  • $hidden (bool) — 隠しメタデータを取得する場合はtrueを指定します(デフォルトはfalse)。

例1: 投稿のカスタムフィールドを取得

投稿IDがget_the_ID()の投稿から、カスタムフィールド「example_field」を取得します。

<?php
$value = acf_get_metadata( get_the_ID(), 'example_field' );
?>

例2: ユーザーメタデータの取得

特定のユーザーIDを持つユーザーのカスタムメタデータ「user_meta_field」を取得します。

<?php
$user_meta = acf_get_metadata( get_current_user_id(), 'user_meta_field' );
?>

例3: タームメタデータを取得

タームIDがget_queried_object_id()のタームから、カスタムメタデータ「term_meta_field」を取得します。

<?php
$term_meta = acf_get_metadata( get_queried_object_id(), 'term_meta_field' );
?>

例4: オプションページのカスタムメタデータを取得

オプションページの特定のカスタムメタデータ「option_meta_field」を取得します。

<?php
$option_meta = acf_get_metadata( 'options', 'option_meta_field' );
?>

例5: 隠しメタデータの取得

隠しメタデータを含む「hidden_field」を投稿から取得します。

<?php
$hidden_value = acf_get_metadata( get_the_ID(), 'hidden_field', true );
?>

注意点

  • データが正しく取得されない場合、nullまたはfalseを返すことがあります。
  • 隠しメタデータを取得する場合は$hidden引数を明示的にtrueに設定してください。