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

mb_str_pad

Description

The mb_str_pad of Multibyte String for PHP pad a multibyte string to a certain length with another multibyte string.

Syntax

mb_str_pad(
    string $string,
    int $length,
    string $pad_string = " ",
    int $pad_type = STR_PAD_RIGHT,
    ?string $encoding = null
): string

Parameters

string

The input string.

length

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. By default STR_PAD_RIGHT.

encoding

The encoding parameter is the character encoding. If it is omitted or null, the internal character encoding value will be used.

Return

Returns the padded string.

Examples

1 · string length · negative

<?

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

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

var_export($return);

'🐘string'

2 · string length · non-negative

<?

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

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

var_export($return);

'🐘string   '

3 · pad_string

<?

$string = '🐘string';
$length = 10;
$pad_string = '🐶🐕';

$return = mb_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 = mb_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 = mb_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 = mb_str_pad($string, $length, $pad_string, $pad_type);

var_export($return);

'🐶🐘string🐶🐕'

7 · encoding

<?

$string = '🐘string';
$length = 10;
$pad_string = '🐶🐕';
$pad_type = STR_PAD_BOTH;
$encoding = 'UTF-8';

$return = mb_str_pad($string, $length, $pad_string, $pad_type, $encoding);

var_export($return);

'🐶🐘string🐶🐕'