mb_str_pad

Pad a multibyte string to a certain length with another multibyte string.

mb_str_pad Function synopsis

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

Parameters

$string

Typestring

The input string.

$length

Typeint

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

OptionalTypestringDefault value" "

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

OptionalTypeintDefault valueSTR_PAD_RIGHT

Optional argument $pad_type can be STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH. By default STR_PAD_RIGHT.

$encoding

OptionalType?stringDefault valuenull

Return value

Typestring

Returns the padded string.