関数の概要
array_pad は、PHPで配列の要素数が指定したサイズに満たない場合に、指定した値で配列を拡張(パディング)するための関数です。配列の長さを一定に保ちたいときや、足りない要素を補完したいときに便利です。
パラメータの説明
array(配列): パディング対象の配列。size(整数): パディング後の配列の最終的なサイズ。正の整数の場合は右側にパディングされ、負の整数の場合は左側にパディングされます。value(任意の型): 配列の不足分を埋めるために使用する値。省略するとNULLが使われます。
戻り値
指定したサイズにパディングされた新しい配列が返されます。元の配列の要素が指定したサイズ以上であれば、そのままの配列が返されます。
使用例
基本的な使い方
<?php
$arr = [1, 2, 3];
$result = array_pad($arr, 5, 0);
print_r($result);
?>
元の配列 [1, 2, 3] に対し、サイズが5になるまで右側に 0 を追加します。結果は [1, 2, 3, 0, 0] となります。
左側にパディングする例
<?php
$arr = ['a', 'b'];
$result = array_pad($arr, -4, 'x');
print_r($result);
?>
サイズを -4 と負の値にすると、左側にパディングします。この場合は ['x', 'x', 'a', 'b'] となります。
元の配列がサイズ以上の場合
<?php
$arr = [10, 20, 30, 40];
$result = array_pad($arr, 3, 'padding');
print_r($result);
?>
元の配列のサイズが3より大きいため、パディングは行われず、元の配列 [10, 20, 30, 40] がそのまま返されます。
関連する関数
array_merge:複数の配列を結合するarray_slice:配列の一部を切り出すarray_fill:指定した値で配列を埋める
まとめ
array_pad は、配列の要素数を特定のサイズに揃えたいときに非常に便利な関数です。右パディング・左パディングが簡単に行え、特にデータの整形処理やデフォルト値の補完に使いやすいため、配列操作を行う際はぜひ覚えておきたい関数のひとつです。
