wp_parse_id_list()


WordPress関数wp_parse_id_list()は、入力された値を配列として解析し、数値のみを含む配列を返すために使用されます。この関数は、特定の用途でIDリストを扱う際に便利です。

構文

wp_parse_id_list( mixed $list )
  • $list (mixed) — IDリストとして解析する値。この引数は配列またはカンマ区切りの文字列を受け入れます。

返り値:

  • array — 整数値のみを含む配列。

例1: 文字列形式のIDリストを解析

カンマ区切りの文字列を配列に変換します。

<?php
$result = wp_parse_id_list( '123,456,789' );
print_r( $result );
// 出力: Array ( [0] => 123 [1] => 456 [2] => 789 )
?>

例2: 配列形式のIDリストを解析

数値のみが含まれる配列を取得します。

<?php
$result = wp_parse_id_list( array( '123', '456abc', 789 ) );
print_r( $result );
// 出力: Array ( [0] => 123 [1] => 789 )
?>

例3: 空の値を解析

空の値を渡した場合、空の配列を返します。

<?php
$result = wp_parse_id_list( '' );
print_r( $result );
// 出力: Array ( )
?>

例4: 無効な値を含む文字列を解析

無効な値はスキップされます。

<?php
$result = wp_parse_id_list( '123,abc,456,def' );
print_r( $result );
// 出力: Array ( [0] => 123 [1] => 456 )
?>

例5: ユーザー入力から取得した値を解析

フォームから送信された値を安全に解析します。

<?php
$user_input = '12,34,invalid,56';
$ids = wp_parse_id_list( sanitize_text_field( $user_input ) );
print_r( $ids );
// 出力: Array ( [0] => 12 [1] => 34 [2] => 56 )
?>

注意事項

  • 文字列中に数値以外の値が含まれている場合、それらは無視されます。
  • 配列に変換された値はすべて整数型になります。
  • 安全なデータ処理のため、ユーザー入力を渡す際はsanitize_text_field()などの関数でフィルタリングしてください。

関連機能: