ARRAY_PAD(3) 1 ARRAY_PAD(3)
array_pad - Pad array to the specified length with a value
SYNOPSIS
array array_pad (array $array, int $size, mixed $value)
DESCRIPTION
array_pad(3) returns a copy of the $array padded to size specified by $size with value $value. If $size is positive then the array is
padded on the right, if it's negative then on the left. If the absolute value of $size is less than or equal to the length of the $array
then no padding takes place. It is possible to add at most 1048576 elements at a time.
PARAMETERS
o $array
- Initial array of values to pad.
o $size
- New size of the array.
o $value
- Value to pad if $array is less than $size.
RETURN VALUES
Returns a copy of the $array padded to size specified by $size with value $value. If $size is positive then the array is padded on the
right, if it's negative then on the left. If the absolute value of $size is less than or equal to the length of the $array then no padding
takes place.
EXAMPLES
Example #1
array_pad(3) example
<?php
$input = array(12, 10, 9);
$result = array_pad($input, 5, 0);
// result is array(12, 10, 9, 0, 0)
$result = array_pad($input, -7, -1);
// result is array(-1, -1, -1, -1, 12, 10, 9)
$result = array_pad($input, 2, "noop");
// not padded
?>
SEE ALSO
array_fill(3), range(3).
PHP Documentation Group ARRAY_PAD(3)
