PHP str_pad() Function

PHP String Functions

Example

Pad the string on the right to a new length of 30 characters:

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

Run Instances

Definition and Usage

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

Syntax

str_pad(string,length,pad_string,pad_type)
Parameters Description
string Required. Specifies the string to pad.
length Required. Specifies the new string length. If this value is less than the original length of the string, no operation is performed.
pad_string Optional. Specifies the string to use for padding. Default is whitespace.
pad_type

Optional. Specifies which side of the padding string to use.

Possible Values:

  • STR_PAD_BOTH - Pad the string on both sides. If it is not even, the right side gets additional padding.
  • STR_PAD_LEFT - Pad the string on the left.
  • STR_PAD_RIGHT - Pad the string on the right. Default.

Technical Details

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

More Examples

Example 1

Pad the string on the left side:

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

Run Instances

Example 2

Pad the string on both sides:

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

Run Instances

PHP String Functions