<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Strip whitespace (or other characters) from the beginning of a string</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.localeconv.html">localeconv</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.md5-file.html">md5_file</a></div> <div class="up"><a href="ref.strings.html">String Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.ltrim" class="refentry"> <div class="refnamediv"> <h1 class="refname">ltrim</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ltrim</span> — <span class="dc-title">Strip whitespace (or other characters) from the beginning of a string</span></p> </div> <div class="refsect1 description" id="refsect1-function.ltrim-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><strong>ltrim</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$charlist</code></span> ] )</div> <p class="para rdfs-comment"> Strip whitespace (or other characters) from the beginning of a string. </p> </div> <div class="refsect1 parameters" id="refsect1-function.ltrim-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">str</code></em></span> <dd> <p class="para"> The input string. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">charlist</code></em></span> <dd> <p class="para"> You can also specify the characters you want to strip, by means of the <em><code class="parameter">charlist</code></em> parameter. Simply list all characters that you want to be stripped. With <em>..</em> you can specify a range of characters. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ltrim-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> This function returns a string with whitespace stripped from the beginning of <em><code class="parameter">str</code></em>. Without the second parameter, <span class="function"><strong>ltrim()</strong></span> will strip these characters: <ul class="itemizedlist"> <li class="listitem"> <span class="simpara"> " " (<acronym title="American Standard Code for Information Interchange">ASCII</acronym> <em>32</em> (<em>0x20</em>)), an ordinary space. </span> </li> <li class="listitem"> <span class="simpara"> "\t" (<acronym title="American Standard Code for Information Interchange">ASCII</acronym> <em>9</em> (<em>0x09</em>)), a tab. </span> </li> <li class="listitem"> <span class="simpara"> "\n" (<acronym title="American Standard Code for Information Interchange">ASCII</acronym> <em>10</em> (<em>0x0A</em>)), a new line (line feed). </span> </li> <li class="listitem"> <span class="simpara"> "\r" (<acronym title="American Standard Code for Information Interchange">ASCII</acronym> <em>13</em> (<em>0x0D</em>)), a carriage return. </span> </li> <li class="listitem"> <span class="simpara"> "\0" (<acronym title="American Standard Code for Information Interchange">ASCII</acronym> <em>0</em> (<em>0x00</em>)), the <em>NUL</em>-byte. </span> </li> <li class="listitem"> <span class="simpara"> "\x0B" (<acronym title="American Standard Code for Information Interchange">ASCII</acronym> <em>11</em> (<em>0x0B</em>)), a vertical tab. </span> </li> </ul> </p> </div> <div class="refsect1 changelog" id="refsect1-function.ltrim-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>4.1.0</td> <td> The <em><code class="parameter">charlist</code></em> parameter was added. </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 examples" id="refsect1-function.ltrim-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4844"> <p><strong>Example #1 Usage example of <span class="function"><strong>ltrim()</strong></span></strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$text </span><span style="color: #007700">= </span><span style="color: #DD0000">"\t\tThese are a few words :) ... "</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$binary </span><span style="color: #007700">= </span><span style="color: #DD0000">"\x09Example string\x0A"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$hello </span><span style="color: #007700">= </span><span style="color: #DD0000">"Hello World"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$text</span><span style="color: #007700">, </span><span style="color: #0000BB">$binary</span><span style="color: #007700">, </span><span style="color: #0000BB">$hello</span><span style="color: #007700">);<br /><br />print </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /><br /></span><span style="color: #0000BB">$trimmed </span><span style="color: #007700">= </span><span style="color: #0000BB">ltrim</span><span style="color: #007700">(</span><span style="color: #0000BB">$text</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$trimmed</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$trimmed </span><span style="color: #007700">= </span><span style="color: #0000BB">ltrim</span><span style="color: #007700">(</span><span style="color: #0000BB">$text</span><span style="color: #007700">, </span><span style="color: #DD0000">" \t."</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$trimmed</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$trimmed </span><span style="color: #007700">= </span><span style="color: #0000BB">ltrim</span><span style="color: #007700">(</span><span style="color: #0000BB">$hello</span><span style="color: #007700">, </span><span style="color: #DD0000">"Hdle"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$trimmed</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// trim the ASCII control characters at the beginning of $binary<br />// (from 0 to 31 inclusive)<br /></span><span style="color: #0000BB">$clean </span><span style="color: #007700">= </span><span style="color: #0000BB">ltrim</span><span style="color: #007700">(</span><span style="color: #0000BB">$binary</span><span style="color: #007700">, </span><span style="color: #DD0000">"\x00..\x1F"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$clean</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> string(32) " These are a few words :) ... " string(16) " Example string " string(11) "Hello World" string(30) "These are a few words :) ... " string(30) "These are a few words :) ... " string(7) "o World" string(15) "Example string " </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.ltrim-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.trim.html" class="function" rel="rdfs-seeAlso">trim()</a> - Strip whitespace (or other characters) from the beginning and end of a string</span></li> <li class="member"> <span class="function"><a href="function.rtrim.html" class="function" rel="rdfs-seeAlso">rtrim()</a> - Strip whitespace (or other characters) from the end of a string</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.localeconv.html">localeconv</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.md5-file.html">md5_file</a></div> <div class="up"><a href="ref.strings.html">String Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>