PHP str_pad() Function

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

string str_pad ( string $input , int $pad_length [, string $pad_string = " " [, int $pad_type = STR_PAD_RIGHT ]] )

This function returns the input string padded on the left, the right, or both sides to the specified padding length. If the optional argument pad_string is not supplied, the input is padded with spaces, otherwise it is padded with characters from pad_string up to the limit.

Example -

Parameter

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.

Returns the padded string.