Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

str_pad

Description

Pad a string to a certain length with another string

Syntax

 str_pad(
    string $string,
    int $length,
    string $pad_string = " ",
    int $pad_type = STR_PAD_RIGHT
): string

Parameters

string

The input string.

length

The desired length of the final padded string. If the value of length is negative, less than, or equal to the length of the input string, no padding takes place, and string 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

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

1 · string length · negative

<?

$string = 'string';
$length = -10;

$return = str_pad($string, $length);

var_export($return);

?>
'string'

2 · string length · non-negative

<?

$string = 'string';
$length = 10;

$return = str_pad($string, $length);

var_export($return);

?>
'string    '

3 · pad_string

<?

$string = 'string';
$length = 10;
$pad_string = ".|";

$return = str_pad($string, $length, $pad_string);

var_export($return);

?>
'string.|.|'

4 · pad_type · STR_PAD_RIGHT

<?

$string = 'string';
$length = 10;
$pad_string = ".|";
$pad_type = STR_PAD_RIGHT;

$return = str_pad($string, $length, $pad_string, $pad_type);

var_export($return);

?>
'string.|.|'

5 · pad_type · STR_PAD_LEFT

<?

$string = 'string';
$length = 10;
$pad_string = ".|";
$pad_type = STR_PAD_LEFT;

$return = str_pad($string, $length, $pad_string, $pad_type);

var_export($return);

?>
'.|.|string'

6 · pad_type · STR_PAD_BOTH

<?

$string = 'string';
$length = 10;
$pad_string = ".|";
$pad_type = STR_PAD_BOTH;

$return = str_pad($string, $length, $pad_string, $pad_type);

var_export($return);

?>
'.|string.|'
HomeMenu