str_pad
Description
Syntax
str_pad( string $string, int $length, string $pad_string = " ", int $pad_type = STR_PAD_RIGHT ): string
Parameters
string
The input string.
length
The desired length of the final padded string. 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
NOTE: 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
Can be STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH. If pad_type is not specified it is assumed to be STR_PAD_RIGHT.
Return
Returns the padded string.
Examples
1 · string length · negative
<? $string = 'string'; $length = -10; $return = str_pad($string, $length); var_export($return); ?>
'string'
2 · string length · non-negative
<? $string = 'string'; $length = 10; $return = str_pad($string, $length); var_export($return); ?>
'string '
3 · pad_string
<? $string = 'string'; $length = 10; $pad_string = ".|"; $return = str_pad($string, $length, $pad_string); var_export($return); ?>
'string.|.|'
4 · pad_type · STR_PAD_RIGHT
<? $string = 'string'; $length = 10; $pad_string = ".|"; $pad_type = STR_PAD_RIGHT; $return = str_pad($string, $length, $pad_string, $pad_type); var_export($return); ?>
'string.|.|'
5 · pad_type · STR_PAD_LEFT
<? $string = 'string'; $length = 10; $pad_string = ".|"; $pad_type = STR_PAD_LEFT; $return = str_pad($string, $length, $pad_string, $pad_type); var_export($return); ?>
'.|.|string'
6 · pad_type · STR_PAD_BOTH
<? $string = 'string'; $length = 10; $pad_string = ".|"; $pad_type = STR_PAD_BOTH; $return = str_pad($string, $length, $pad_string, $pad_type); var_export($return); ?>
'.|string.|'
Links
String
- addcslashes
- addslashes
- bin2hex
- chop
- chr
- chunk_split
- convert_uudecode
- convert_uuencode
- count_chars
- crc32
- crypt
- echo
- explode
- fprintf
- get_html_translation_table
- hebrev
- hebrevc
- hex2bin
- html_entity_decode
- htmlentities
- htmlspecialchars
- htmlspecialchars_decode
- implode
- join
- lcfirst
- levenshtein
- localeconv
- ltrim
- md5
- md5_file
- metaphone
- nl_langinfo
- nl2br
- number_format
- ord
- parse_str
- printf
- quoted_printable_decode
- quoted_printable_encode
- quotemeta
- rtrim
- setlocale
- sha1
- sha1_file
- similar_text
- soundex
- sprintf
- sscanf
- str_contains
- str_decrement
- str_ends_with
- str_getcsv
- str_increment
- str_ireplace
- str_repeat
- str_replace
- str_rot13
- str_shuffle
- str_split
- str_starts_with
- str_word_count
- strcasecmp
- strchr
- strcmp
- strcoll
- strcspn
- strip_tags
- stripcslashes
- stripos
- stripslashes
- stristr
- strlen
- strnatcasecmp
- strnatcmp
- strncasecmp
- strncmp
- strpbrk
- strpos
- strrchr
- strrev
- strripos
- strrpos
- strspn
- strstr
- strtok
- strtolower
- strtoupper
- strtr
- substr
- substr_compare
- substr_count
- substr_replace
- trim
- ucfirst
- ucwords
- vfprintf
- vprintf
- vsprintf
- wordwrap