acf_with_default()


関数acf_with_default()は、Advanced Custom Fields (ACF) プラグインのカスタムフィールドを取得し、デフォルト値を設定できる機能です。この関数は、フィールド値が存在しない場合にデフォルト値を返すように設計されています。

シンタックス

acf_with_default( string $field_name, mixed $default_value );

引数の説明

  • $field_name (string) — 取得したいACFフィールドの名前。
  • $default_value (mixed) — フィールドが空の場合に返されるデフォルト値。

使用例

例 1: テキストフィールドの値を取得

ACFフィールドの値を取得し、デフォルト値を設定します。

<?php echo acf_with_default( 'custom_text_field', 'デフォルトテキスト' ); ?>

例 2: 数値フィールドのデフォルト値を設定

数値フィールドが空の場合、デフォルト値として100を返します。

<?php echo acf_with_default( 'custom_number_field', 100 ); ?>

例 3: 配列型フィールドの使用

ACFフィールドが配列型の場合にデフォルト配列を返します。

<?php
$field_value = acf_with_default( 'custom_array_field', [ 'key1' => 'value1', 'key2' => 'value2' ] );
print_r( $field_value );
?>

例 4: 条件に応じたデフォルト値の設定

特定の条件に基づいて異なるデフォルト値を設定します。

<?php
$default_value = is_user_logged_in() ? 'ログイン中' : 'ゲスト';
echo acf_with_default( 'user_status_field', $default_value );
?>

例 5: HTML出力を含むフィールド

HTMLを含むカスタムフィールドを取得し、デフォルトのHTMLを設定します。

<?php
echo acf_with_default( 'custom_html_field', '<div>デフォルトHTML</div>' );
?>

注意点

  • acf_with_default()は、ACFプラグインが有効化されている環境でのみ動作します。
  • フィールド名が正しくない場合、デフォルト値が返されます。
  • 返される値の型は$default_valueの型に依存します。

関連機能：