array_pad() - 配列を指定長で埋める

公開日: 2016/12/18

array_padは、ある配列から指定した長さの新しい配列を作り、長さが足りない分は指定した値で埋める関数です。

構文

array array_pad ( array $array , int $size , mixed $value )

対象の配列。

埋める要素数を指定する。正の数なら右側から、負の数なら左側が埋められる。

第1引数の配列の要素数が、第2引数で指定した数より少ない場合に埋める値。

array

指定した配列を指定長にして、足りない分を第2引数、第3引数の条件通りに埋めた新しい配列。

要素数が3個の配列から、要素数が5個の配列を作ります。足りない2個の要素は、第3引数で指定した値になります。

php

<?php

	// 配列
	$queue = [ "a", "b", "c" ] ;

	// 実行
	$result = array_pad( $queue, 5, "A" ) ;

	// 返り値
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.21

Array
(
    [0] => a
    [1] => b
    [2] => c
    [3] => A
    [4] => A
)

第2引数に負の値を指定した場合、配列の右側(末尾)ではなく、左側(先頭)が埋められます。

php

<?php

	// 配列
	$queue = [ "a", "b", "c" ] ;

	// 実行
	$result = array_pad( $queue, -5, "A" ) ;

	// 返り値
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.21

Array
(
    [0] => A
    [1] => A
    [2] => a
    [3] => b
    [4] => c
)

ソースコードを編集してarray_pad()の挙動を確認して下さい。

Array
(
    [0] => a
    [1] => b
    [2] => c
    [3] => A
    [4] => A
)