wp_parse_id_list() の使い方|説明・引数・注意点

説明

wp_parse_id_list() は、カンマ区切りなどのIDの文字列を、整数の配列に変換する関数です。

基本構文

wp_parse_id_list( array|string $input_list ): int[]

引数

  • $input_list:IDの文字列、または配列

戻り値

整数の配列(重複排除済み)。

使い方(サンプル)

$ids = wp_parse_id_list( '1, 2, 3, 3' );

注意点

  • 空白やカンマで区切られた値に対応します。

実務での使いどころ

  • カンマ区切りの文字列(1,2,3)や、配列を、IDの配列に、整えるとき。
  • ショートコードの属性(ids="1,2,3")を、処理するとき。

よくあるミスと対処

  • 重複が、取り除かれる。並びや、重複を保ちたいときには、向かない。
  • 数値でない値は 0 に、負の数は正の数に、変換される(absint() が使われる)。

NG例

$ids = explode( ',', $atts['ids'] ); // 空白や、数値でない値が、混ざる

OK例

$ids = wp_parse_id_list( $atts['ids'] );

使い分け早見表

関数 役割
wp_parse_id_list() IDの一覧(文字列・配列)を、整数の配列に整える
absint() 1つの値を、0以上の整数にする
explode() 文字列を、区切って配列にする(検証なし)

関連項目

wp_parse_slug_list()、absint()

公式リファレンス:wp_parse_id_list() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました