str_pad
str_pad
(PHP 4 >= 4.0.1, PHP 5, PHP 7)
str_pad — Pad a string to a certain length with another string
Description
string str_pad ( string $input , int $pad_length [, string $pad_string = " " [, int $pad_type = STR_PAD_RIGHT ]] )
This functions returns the input string padded on the left, the right, or both sides to the specified padding length. If the optional argument pad_string is not supplied, the input is padded with spaces, otherwise it is padded with characters from pad_string up to the limit.
Parameters
-
input -
The input string.
-
pad_length -
If the value of
pad_lengthis negative, less than, or equal to the length of the input string, no padding takes place, andinputwill be returned. -
pad_string -
Note:
The
pad_stringmay be truncated if the required number of padding characters can't be evenly divided by thepad_string's length. -
pad_type -
Optional argument
pad_typecan beSTR_PAD_RIGHT,STR_PAD_LEFT, orSTR_PAD_BOTH. Ifpad_typeis not specified it is assumed to beSTR_PAD_RIGHT.
Return Values
Returns the padded string.
Examples
Example #1 str_pad() example
<?php $input = "Alien"; echo str_pad($input, 10); // produces "Alien " echo str_pad($input, 10, "-=", STR_PAD_LEFT); // produces "-=-=-Alien" echo str_pad($input, 10, "_", STR_PAD_BOTH); // produces "__Alien___" echo str_pad($input, 6, "___"); // produces "Alien_" echo str_pad($input, 3, "*"); // produces "Alien" ?>
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/function.str-pad.php
