str_pad

Pad a string to a certain length with another string

Syntax

str_pad ( string $input , int $pad_length [, string $pad_string = " " [, int $pad_type = STR_PAD_RIGHT ]] ) : string

Parameters

input

The input string.

pad_length

If the value of pad_length is negative, less than, or equal to the length of the input string, no padding takes place, and input will be returned.

pad_string

Note: The pad_string may be truncated if the required number of padding characters can't be evenly divided by the pad_string's length.

pad_type

Optional argument pad_type can be STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH. If pad_type is not specified it is assumed to be STR_PAD_RIGHT.

Return

Returns the padded string.

Examples

1 · input pad_length

<?

$input = "Hello";
$pad_length = 10;

$return = str_pad($input, $pad_length);

var_dump($return);

?>
string(10) "Hello     "

2 · pad_string

<?

$input = "Hello";
$pad_length = 10;
$pad_string = "-|";

$return = str_pad($input, $pad_length, $pad_string);

var_dump($return);

?>
string(10) "Hello-|-|-"

3 · pad_type · STR_PAD_RIGHT

<?

$input = "Hello";
$pad_length = 10;
$pad_string = "-|";
$pad_type = STR_PAD_RIGHT;

$return = str_pad($input, $pad_length, $pad_string, $pad_type);

var_dump($return);

?>
string(10) "Hello-|-|-"

4 · pad_type · STR_PAD_LEFT

<?

$input = "Hello";
$pad_length = 10;
$pad_string = "-|";
$pad_type = STR_PAD_LEFT;

$return = str_pad($input, $pad_length, $pad_string, $pad_type);

var_dump($return);

?>
string(10) "-|-|-Hello"

5 · pad_type · STR_PAD_BOTH

<?

$input = "Hello";
$pad_length = 10;
$pad_string = "-|";
$pad_type = STR_PAD_BOTH;

$return = str_pad($input, $pad_length, $pad_string, $pad_type);

var_dump($return);

?>
string(10) "-|Hello-|-"

addcslashes

addslashes

bin2hex

chop

chr

chunk_split

convert_uudecode

convert_uuencode

count_chars

crc32

crypt

echo

explode

fprintf

get_html_translation_table

hebrev

hebrevc

hex2bin

html_entity_decode

htmlentities

htmlspecialchars

htmlspecialchars_decode

implode

join

lcfirst

levenshtein

localeconv

ltrim

md5

md5_file

metaphone

nl_langinfo

nl2br

number_format

ord

parse_str

print

printf

quoted_printable_decode

quoted_printable_encode

quotemeta

rtrim

setlocale

sha1

sha1_file

similar_text

soundex

sprintf

sscanf

str_contains

str_ends_with

str_getcsv

str_ireplace

str_repeat

str_replace

str_rot13

str_shuffle

str_split

str_starts_with

str_word_count

strcasecmp

strchr

strcmp

strcoll

strcspn

strip_tags

stripcslashes

stripos

stripslashes

stristr

strlen

strnatcasecmp

strnatcmp

strncasecmp

strncmp

strpbrk

strpos

strrchr

strrev

strripos

strrpos

strspn

strstr

strtok

strtolower

strtoupper

strtr

substr

substr_compare

substr_count

substr_replace

trim

ucfirst

ucwords

vfprintf

vprintf

vsprintf

wordwrap

PHP

Home Menu