str_pad

(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)

str_pad — Дополняет строку другой строкой до заданной длины

Описание

str_pad(
    string $string,
    int $length,
    string $pad_string = " ",
    int $pad_type = STR_PAD_RIGHT
): string

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

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

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

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

Функция возвращает дополненную строку.

Примеры

Пример #1 Пример дополнения строки функцией str_pad()

<?php

$input = "Alien";

echo str_pad($input, 10), PHP_EOL;                      // Выводит "Alien     "
echo str_pad($input, 10, "-=", STR_PAD_LEFT), PHP_EOL;  // Выводит "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH), PHP_EOL;   // Выводит "__Alien___"
echo str_pad($input,  6, "___"), PHP_EOL;               // Выводит "Alien_"
echo str_pad($input,  3, "*"), PHP_EOL;                 // Выводит "Alien"

?>

Смотрите также

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