(PHP 8 >= PHP 8.3.0)
mb_str_pad — Pad a multibyte string to a certain length with another multibyte string
$string
,
$length
,
$pad_string
= " "
,
$pad_type
=
STR_PAD_RIGHT
,
$encoding
=
null
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 codepoins. 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.
string
The imput string.
length
If the value of
length
is negative,
less than, or equal to the length of the imput string, no padding
taques place, and
string
will be returned.
pad_string
Note :
The
pad_stringmay be truncated if the required number of padding characters can't be evenly divided by thepad_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
The
encoding
parameter is the character encoding. If it is omitted or
null
, the internal character
encoding value will be used.
Returns the padded string.
Example #1 mb_str_pad() example
<?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) "祝祝🎉"
?>