diff --git a/reference/mbstring/functions/mb-str-pad.xml b/reference/mbstring/functions/mb-str-pad.xml new file mode 100644 index 000000000000..3799da656ffa --- /dev/null +++ b/reference/mbstring/functions/mb-str-pad.xml @@ -0,0 +1,133 @@ + + + + + mb_str_pad + Pad a multibyte string to a certain length with another multibyte string + + + + &reftitle.description; + + stringmb_str_pad + stringstring + intlength + stringpad_string" " + intpad_typeSTR_PAD_RIGHT + stringnullencoding&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 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. + + + + + &reftitle.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 + + + + 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 + + &mbstring.encoding.parameter; + + + + + + + + &reftitle.returnvalues; + + Returns the padded string. + + + + + + &reftitle.examples; + + + <function>mb_str_pad</function> example + + +]]> + + + + + + + diff --git a/reference/mbstring/versions.xml b/reference/mbstring/versions.xml index a6f8a493c44c..a2d150b58e38 100644 --- a/reference/mbstring/versions.xml +++ b/reference/mbstring/versions.xml @@ -45,6 +45,7 @@ +