Easy Tutorial
❮ Func Directory Dir Func String Htmlspecialchars Decode ❯

PHP str_pad() Function

PHP String Reference Manual

Example

Pad the right side of a string to a new length of 20 characters:

<?php
$str = "Hello World";
echo str_pad($str,20,".");
?>

Definition and Usage

The str_pad() function pads a string to a new length.


Syntax

Parameter Description
string Required. Specifies the string to pad.
length Required. Specifies the new string length. If this value is less than the original string length, nothing will be done.
pad_string Optional. Specifies the string to use for padding. Default is whitespace.
pad_type Optional. Specifies which side to pad the string. Possible values: STR_PAD_BOTH - Pads both sides of the string. If not even, the right side gets the extra padding.<br> STR_PAD_LEFT - Pads the left side of the string.<br> STR_PAD_RIGHT - Pads the right side of the string. This is the default.

Technical Details

Return Value: Returns the padded string.
PHP Version: 4.0.1+
--- ---

More Examples

Example 1

Pad the left side of the string:

<?php
$str = "Hello World";
echo str_pad($str,20,".",STR_PAD_LEFT);
?>

Example 2

Pad both sides of the string:

<?php
$str = "Hello World";
echo str_pad($str,20,".:",STR_PAD_BOTH);
?>

The output will be:

.:.:Hello World.:.:.

❮ Func Directory Dir Func String Htmlspecialchars Decode ❯