<HTML ><HEAD ><TITLE >str_pad</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="PHP Manual" HREF="index.html"><LINK REL="UP" TITLE="String functions" HREF="ref.strings.html"><LINK REL="PREVIOUS" TITLE="sscanf" HREF="function.sscanf.html"><LINK REL="NEXT" TITLE="str_repeat" HREF="function.str-repeat.html"><META HTTP-EQUIV="Content-type" CONTENT="text/html; charset=ISO-8859-1"></HEAD ><BODY CLASS="refentry" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >PHP Manual</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="function.sscanf.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="function.str-repeat.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="function.str-pad" ></A >str_pad</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN90792" ></A ><P > (PHP 4 >= 4.0.1)</P >str_pad -- Pad a string to a certain length with another string </DIV ><DIV CLASS="refsect1" ><A NAME="AEN90795" ></A ><H2 >Description</H2 >string <B CLASS="methodname" >str_pad</B > ( string input, int pad_length [, string pad_string [, int pad_type]])<BR ></BR ><P > This functions returns the <TT CLASS="parameter" ><I >input</I ></TT > string padded on the left, the right, or both sides to the specified padding length. If the optional argument <TT CLASS="parameter" ><I >pad_string</I ></TT > is not supplied, the <TT CLASS="parameter" ><I >input</I ></TT > is padded with spaces, otherwise it is padded with characters from <TT CLASS="parameter" ><I >pad_string</I ></TT > up to the limit. </P ><P > Optional argument <TT CLASS="parameter" ><I >pad_type</I ></TT > can be STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH. If <TT CLASS="parameter" ><I >pad_type</I ></TT > is not specified it is assumed to be STR_PAD_RIGHT. </P ><P > If the value of <TT CLASS="parameter" ><I >pad_length</I ></TT > is negative or less than the length of the input string, no padding takes place. </P ><P > <TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" CLASS="EXAMPLE" ><TR ><TD ><DIV CLASS="example" ><A NAME="AEN90823" ></A ><P ><B >Example 1. <B CLASS="function" >str_pad()</B > example</B ></P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" CELLPADDING="5" ><TR ><TD ><PRE CLASS="php" >$input = "Alien"; print str_pad($input, 10); // produces "Alien " print str_pad($input, 10, "-=", STR_PAD_LEFT); // produces "-=-=-Alien" print str_pad($input, 10, "_", STR_PAD_BOTH); // produces "__Alien___"</PRE ></TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE > </P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="function.sscanf.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="function.str-repeat.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >sscanf</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="ref.strings.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >str_repeat</TD ></TR ></TABLE ></DIV ></BODY ></HTML >