関数 array_pad

関数 array_pad は、配列を指定されたサイズまで特定の値でパディング（補充）します。 第一引数にはパディングする配列を、 第二引数にはどのサイズまで埋めるかを、 第三引数には何で埋めるかを指定します。

第二引数は負の値にすることができます - この場合、配列は末尾ではなく先頭から要素で補充されます。

構文

phparray_pad(array $array, int $length, mixed $value): array

例

配列をゼロで埋めて、サイズが 7 要素になるようにしてみましょう：

php<?php
  $arr = ['a', 'b', 'c', 'd', 'e'];
  
  $res = array_pad($arr, 7, 0);
  var_dump($res);
?>

コードの実行結果：

php['a', 'b', 'c', 'd', 'e', 0, 0]

例

今度は配列にすでに 7 要素あるので - 何も補充されません：

php<?php
  $arr = ['a', 'b', 'c', 'd', 'e', 'f', 'g'];
  
  $res = array_pad($arr, 7, 0);
  var_dump($res);
?>

コードの実行結果：

php['a', 'b', 'c', 'd', 'e', 'f', 'g']

例

第二引数を負の値にしてみましょう。 この場合、配列は末尾ではなく先頭から補充されます：

php<?php
  $arr = ['a', 'b', 'c', 'd', 'e'];
  
  $res = array_pad($arr, -7, 0);
  var_dump($res);
?>

コードの実行結果：

php[0, 0, 'a', 'b', 'c', 'd', 'e']

関連項目