mb_str_pad

(PHP 8 >= PHP 8.3.0)

mb_str_pad — Дополняет мультибайтовую строку другой мультибайтовой строкой до заданной длины

Описание

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

Эта функция возвращает строку string, дополненную слева, справа или с обеих сторон до заданной длины, где длина измеряется в кодовых точках Юникода. Если необязательный аргумент pad_string не передан, то строка string будет дополнена пробелами, иначе она будет дополнена символами параметра pad_string до нужной длины.

Список параметров

string: Входная строка.
length: Если значение параметра length отрицательно, меньше или равно длине входной строки, то дополнения не происходит и возвращается исходная строка string.
pad_string: Замечание:
Строка pad_string может быть урезана, если необходимое количество дополняемых символов не делится нацело на длину строки pad_string.
pad_type: Необязательный аргумент pad_type, возможные значения: STR_PAD_RIGHT, STR_PAD_LEFT, или STR_PAD_BOTH. По умолчанию будет использована константа STR_PAD_RIGHT.
encoding: Параметр encoding указывает кодировку символов. При пропуске параметра или передаче значения null функция интерпретирует символы в предустановленной кодировке модуля.

Возвращаемые значения

Возвращает дополненную строку.

Примеры

Пример #1 Пример использования функции mb_str_pad()

<?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) "祝祝🎉"
?>