What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

array_pad
Prev	III. Array-Related Functions	Next

array_pad

Name

array_pad — Pads an array with a specified number of elements with a given value.

Synopsis

array array_pad(array, pad_size, pad_value); array array: Array to pad int pad_size: Number of elements in resulting array mixed pad_value: Value to give to added elements

Returns

Original array, possibly padded to a greater number of elements; NULL on failure

Description

This function pads the array passed in array with elements having the value given in pad_value until it contains the number of elements given by the absolute value of pad_size . If pad_size is positive, the new elements are added to the end of array . If pad_size is negative, the new elements are added to the beginning. If the absolute value of pad_size is equal to or less than the number of elements already in array , no elements are added.

Version

PHP 4 since 4.0b4

Example

Example 26. Left-pad an array

$array = array(1, 2, 3, 4);
$array = array_pad($array, -6, 'NEW');
print_r($array);

Output:
Array
(
    [0] => NEW
    [1] => NEW
    [2] => 1
    [3] => 2
    [4] => 3
    [5] => 4
)

Prev	Home	Next
array_multisort	Up	array_pop

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.