PHPのarray_pad関数の使い方!配列を指定サイズまで埋める

PHPのarray_pad関数は、指定した配列を特定のサイズまで埋めるために使用されます。

配列の要素数が足りない場合に、不足分を同じ値で埋めて配列の長さを揃えたいときに非常に便利です。 特に、固定長のデータ構造を扱う場合や、特定のフォーマットに合わせて配列の長さを調整する場合に役立ちます。

この記事では、array_pad関数の基本的な使い方、埋める方向(左/右)、負の数を指定した場合の挙動、そして使用する際の注意点について解説します。

array_pad関数の基本的な構文

array_pad 関数の基本的な構文は以下の通りです。

array_pad(array $array, int $size, mixed $value): array
  • $array: パディング(埋め込み)を行いたい元の配列です。
  • $size: 結果として得られる配列の新しいサイズ(要素数)を指定する整数です。
    • $size が正の数の場合、配列は右側(末尾)から埋められます。
    • $size が負の数の場合、配列は左側(先頭)から埋められます。
    • $size の絶対値が元の配列の要素数よりも小さい場合、配列は変更されずにそのまま返されます。
  • $value: 配列を埋めるために使用する値です。任意の型(数値、文字列、ブール値、NULL など)を指定できます。

コメント