PHP Manual
Prev |  | Next

# array_pad

array_pad -- Pad array to the specified length with a value

## Description

`array array_pad`(array input, int pad_size, mixed pad_value);

array_pad() returns a copy of the `input` padded to size specified by `pad_size` with value `pad_value`. If `pad_size` is positive then the array is padded on the right, if it's negative then on the left. If the absolute value of `pad_size` is less than or equal to the length of the `input` then no padding takes place.

Example 1. array_pad() example
      1
      2 $input = array (12, 10, 9);
      3
      4 $result = array_pad ($input, 5, 0);
      5 // result is array (12, 10, 9, 0, 0)
      6
      7 $result = array_pad ($input, -7, -1);
      8 // result is array (-1, -1, -1, -1, 12, 10, 9)
      9
     10 $result = array_pad ($input, 2, "noop");
     11 // not padded
     12

Prev | Home | Next
array_merge | Up | array_pop