acf_extract_var()


関数acf_extract_var()は、指定された配列から指定したキーの値を抽出し、その値を返すと同時に、元の配列からそのキーを削除します。

シンタックス

acf_extract_var( array &$array, string $key );

引数の説明

  • $array (array) — 値を抽出する対象となる配列。
  • $key (string) — 配列から抽出するキー。

戻り値

  • (mixed) — 抽出された値。キーが存在しない場合はnullを返します。

例1: 配列から特定のキーの値を抽出する

<?php
$array = array( 'name' => 'WordPress', 'type' => 'CMS' );
$name = acf_extract_var( $array, 'name' );
echo $name; // WordPress
?>

例2: 存在しないキーを指定した場合

<?php
$array = array( 'name' => 'WordPress' );
$type = acf_extract_var( $array, 'type' );
var_dump( $type ); // null
?>

例3: 配列内の残りの要素を確認する

<?php
$array = array( 'name' => 'WordPress', 'type' => 'CMS' );
acf_extract_var( $array, 'name' );
print_r( $array ); // Array ( [type] => CMS )
?>

例4: 入れ子になった配列での使用

<?php
$array = array( 'settings' => array( 'color' => 'blue', 'size' => 'large' ) );
$settings = acf_extract_var( $array, 'settings' );
print_r( $settings ); // Array ( [color] => blue [size] => large )
?>

例5: 抽出後の動的な処理

<?php
$array = array( 'post_id' => 123, 'title' => 'Hello World' );
$post_id = acf_extract_var( $array, 'post_id' );
if ( $post_id ) {
    echo 'Post ID: ' . $post_id;
}
?>

注意事項

  • $arrayは参照渡しであるため、元の配列は変更されます。
  • 指定された$keyが存在しない場合、元の配列は変更されません。