Menu Samaritan's Purse

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

INPUT PAD_LENGTH

string(10) "Hello     "

PAD_STRING

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

PAD_TYPE | STR_PAD_RIGHT

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

PAD_TYPE | STR_PAD_LEFT

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

PAD_TYPE | STR_PAD_BOTH

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

PHP