str_pad

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

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

Описание

str_pad ( string $input , int $pad_length [, string $pad_string = " " [, int $pad_type = STR_PAD_RIGHT ]] ) : string

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

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

input: Входная строка.
pad_length: Если значение pad_length отрицательно, меньше или равно длине входной строки, то дополнения не происходит и возвращается исходная строка input.
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);                      // выводит "Alien     "
echo str_pad($input, 10, "-=", STR_PAD_LEFT);  // выводит "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH);   // выводит "__Alien___"
echo str_pad($input,  6, "___");               // выводит "Alien_"
echo str_pad($input,  3, "*");                 // выводит "Alien"
?>