PHP str_pad() function

PHP String functions

Example

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

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

Run Instance

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 be padded.
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 be used for padding. Default is whitespace.
pad_type

Optional. Specifies which side of the string to pad.

Possible Values:

  • STR_PAD_BOTH - Pad both sides of the string. If it is not even, the right side gets additional padding.
  • STR_PAD_LEFT - Pad the left side of the string.
  • STR_PAD_RIGHT - Pad the right side of the string. 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,30,".",STR_PAD_LEFT);
?>

Run Instance

Example 2

Pad both sides of the string:

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

Run Instance

PHP String functions