PHP str_pad()Functions

PHP String 参考手册PHP String Reference Manual

Examples

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

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

Run example »

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 length of the new string. If this value is less than the original length of the string, nothing is done.
pad_string Optional. Specifies the string to use for padding. Default is whitespace.
pad_type Optional. Specifies which side of the string to pad.

Possible values:

  • STR_PAD_BOTH - Pads both sides of the string. If not an even number, the right side gets the extra padding.
  • STR_PAD_LEFT - Pads the left side of the string.
  • 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); ?>

Run example »

Example 2

Pad both sides of the string:

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

The output of the code above will be:

.:.:Hello World.:.:.


PHP String 参考手册PHP String Reference Manual Other Extensions