array_pad
(PHP 4, PHP 5, PHP 7)
array_pad — Pad array to the specified length with a value
Description
array_pad() 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
-
array
-
Initial array of values to pad.
-
size
-
New size of the array.
-
value
-
Value to pad if
array
is less thansize
.
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() 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() - Fill an array with values
- range() - Create an array containing a range of elements
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.array-pad.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.