Home >>PHP String Functions >PHP str_pad() Function

PHP str_pad() Function

PHP str_pad() Function

PHP str_pad() function is used to pad a string to a certain given length. Using this function we can pad the input string by any other string up to a certain length. It returns the given input string padded on the left, right, or both sides. If we do not pass the other string to the function then the input string will be padded by spaces.

Syntax:

   str_pad($string, $length, $pad_string, $pad_type);

Parameter Values

Parameter Description
string This is a required parameter. This parameter contains the string to be pad.
length This is a required parameter. This parameter defines the new string length. If it’s value is less than the original length of the string, nothing will be done.
pad_string This is an optional parameter. This parameter defines the string to use for padding.
pad_type This is an optional parameter. This parameter defines the side to which pad the string. Possible values:
  • STR_PAD_BOTH - Pad to both the sides of the string.
  • STR_PAD_LEFT - Pad only to the left side of the string.
  • STR_PAD_RIGHT - Pad only to the right side of the string.

Here is an example of str_pad() function in PHP:

<html>
<body>

<?php
$str = "PHPTPOINT";
echo str_pad($str,20,"-");
?>

</body>
</html>
Output:
PHPTPOINT-----------

Here is an another example of str_pad() function in PHP:

<html>
<body>

<?php
$str = "Jerry";
echo str_pad($str,20,"_",STR_PAD_LEFT)."<br>";
echo str_pad($str,20,"_",STR_PAD_RIGHT)."<br>";
echo str_pad($str,20,"_",STR_PAD_BOTH)."<br>";
?>

</body>
</html>
Output:
_______________Jerry
Jerry_______________
_______Jerry________

Popular Tutorials

PHP String Functions PHP addcslashes() Function PHP addslashes() Function PHP bin2hex() Function PHP chop() Function PHP chr() Function PHP chunk_split() Function PHP convert_cyr_string() Function PHP convert_uudecode() Function PHP convert_uuencode() Function PHP count_chars() Function PHP crc32() Function PHP crypt() Function PHP echo() Function PHP empty() function PHP explode() Function PHP strcmp() Function PHP fprintf() Function PHP strcoll() Function PHP get_html_translation_table() Function PHP strcspn() Function PHP hebrev() Function PHP strip_tags() Function PHP hebrevc() Function PHP stripcslashes() Function PHP hex2bin() Function PHP stripslashes() Function PHP html_entity_decode() Function PHP stripos() Function PHP htmlentities() Function PHP stristr() Function PHP htmlspecialchars() Function PHP strlen() Function PHP htmlspecialchars_decode() Function PHP strnatcasecmp() Function PHP implode() Function PHP strnatcmp() Function PHP join() Function PHP strncasecmp() Function PHP lcfirst() Function PHP strncmp() Function PHP levenshtein() Function PHP strpos() Function PHP localeconv() Function PHP strpbrk() Function PHP ltrim() Function PHP strrev() Function PHP md5() Function PHP strripos() Function PHP md5_file() Function PHP strrpos() Function PHP metaphone() Function PHP strspn() Function PHP money_format() Function PHP strstr() Function PHP nl_langinfo() Function PHP strtok() Function PHP nl2br() Function PHP strtolower() Function PHP number_format() Function PHP strtoupper() Function PHP ord() Function PHP strtr() Function PHP parse_str() Function PHP substr() Function PHP print() Function PHP substr_compare() Function PHP printf() Function PHP substr_count() Function PHP quoted_printable_decode() Function PHP substr_replace() Function PHP quoted_printable_encode() Function PHP trim() Function PHP quotemeta() Function PHP ucfirst() Function PHP rtrim() Function PHP ucwords() Function PHP setlocale() Function PHP vfprintf() Function PHP sha1() Function PHP vprintf() Function PHP sha1_file() Function PHP vsprintf() Function PHP similar_text() Function PHP wordwrap() Function PHP soundex() Function PHP strrchr Function PHP sprintf() Function PHP sscanf() Function PHP str_getcsv() Function PHP str_ireplace() Function PHP str_pad() Function PHP str_repeat() Function PHP str_replace() Function PHP str_rot13() Function PHP str_shuffle() Function PHP str_split() Function PHP str_word_count() Function PHP strcasecmp() Function PHP strchr() Function