mb-str-pad

mb_str_pad

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

ENTITY

string

mb_str_pad

string

string

int

length

string

pad_string

" "

int

pad_type

STR_PAD_RIGHT

string

null

encoding

ENTITY

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

ENTITY

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
Optional argument pad_type can be STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH. By default STR_PAD_RIGHT.

encoding
ENTITY

ENTITY

Returns the padded string.

ENTITY

<?php
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_RIGHT)); // string(18) "▶▶❤❓❇❤"
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_LEFT));  // string(18) "❤❓❇❤▶▶"
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_BOTH));  // string(18) "❤❓▶▶❤❓"

var_dump(mb_str_pad("🎉", 3, "祝", STR_PAD_LEFT));   // string(10) "祝祝🎉"
?>