array_pad

(PHP 4, PHP 5, PHP 7, PHP 8)

array_pad — 指定長、指定した値で配列を埋める

説明

function array_pad(array $array, int $length, mixed $value): array

array_pad() は、length で指定した長さになるように値 value で埋めて array のコピーを返します。 length が正の場合、配列の右側が埋められます。負の場合、配列の左側が埋められます。 length の絶対値が array の長さ以下の場合、埋める処理は行われません。

パラメータ

array: 値を埋めるもととなる配列。
length: 新しい配列のサイズ。
value: array が length より小さいときに、埋めるために使用する値。

戻り値

length で指定した長さになるように値 value で埋めて array のコピーを返します。 length が正の場合、配列の右側が埋められます。負の場合、配列の左側が埋められます。 length の絶対値が array の長さ以下の場合、埋める処理は行われません。

変更履歴

バージョン	説明
8.3.0	PHP 8.3 より前のバージョンでは、一度に 1048576 個の要素しか追加できませんでした。このバージョンからは、制限は配列の最大サイズのみになりました。

例

例1 array_pad() の例

<?php
$input = array(12, 10, 9);

$result = array_pad($input, 5, 0);
// 結果は、array(12, 10, 9, 0, 0) です。
echo join(', ', $result), PHP_EOL;

$result = array_pad($input, -7, -1);
// 結果は、array(-1, -1, -1, -1, 12, 10, 9) です。
echo join(', ', $result), PHP_EOL;

$result = array_pad($input, 2, "noop");
// 埋める処理は行われません。
echo join(', ', $result), PHP_EOL;
?>

参考

array_fill() - 配列を指定した値で埋める
range() - ある範囲の要素を含む配列を作成する