_wp_array_get()


WordPressの_wp_array_get()関数は、配列からネストされた値を安全に取得するために使用されます。指定されたキーのパスに従って配列を探索し、値が存在しない場合はデフォルト値を返します。

構文

_wp_array_get( array $array, array $path, mixed $default = null );

引数の説明:

  • $array (array) — 探索対象の配列
  • $path (array) — 値を取得するためのキーのパス(配列形式)
  • $default (mixed) — 値が存在しない場合に返されるデフォルト値

例1: 単一キーの取得

配列から単一のキーを使って値を取得します。

$value = _wp_array_get( $array, array( 'key' ), 'default' );

例2: ネストされた配列の値の取得

ネストされた配列から値を取得します。

$value = _wp_array_get( $array, array( 'parent', 'child' ), 'default' );

例3: デフォルト値の使用

値が存在しない場合にデフォルト値を返します。

$value = _wp_array_get( $array, array( 'nonexistent' ), 'fallback' );

例4: 多次元配列の探索

複数の階層を持つ配列から値を取得します。

$value = _wp_array_get( $array, array( 'level1', 'level2', 'level3' ), 'not_found' );

例5: 空のパスを指定

空のパスを指定した場合、デフォルト値が返されます。

$value = _wp_array_get( $array, array(), 'empty_path' );

例6: 配列以外の値の処理

配列以外の値を渡した場合、デフォルト値が返されます。

$value = _wp_array_get( 'not_an_array', array( 'key' ), 'invalid' );

例7: 実際のWordPressデータの使用

投稿メタデータから特定のフィールドを取得します。

$meta = get_post_meta( get_the_ID(), '_custom_meta', true );
$value = _wp_array_get( $meta, array( 'field' ), 'default_value' );

注意点

  • この関数はWordPressのコア関数であり、直接呼び出すことは推奨されません。代わりにwp_array_get()などの公開APIを使用してください。
  • パラメータとして渡す配列のキーは存在することを確認してください。
  • パフォーマンスに影響する可能性があるため、深いネストされた配列の探索は控えめに使用してください。