<!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>Cut out part 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.iconv-strrpos.html">iconv_strrpos</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.iconv.html">iconv</a></div>
<div class="up"><a href="ref.iconv.html">iconv Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.iconv-substr" class="refentry">
<div class="refnamediv">
<h1 class="refname">iconv_substr</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">iconv_substr</span> — <span class="dc-title">Cut out part of a string</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.iconv-substr-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>iconv_substr</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$offset</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code><span class="initializer"> = iconv_strlen($str, $charset)</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$charset</code><span class="initializer"> = ini_get("iconv.internal_encoding")</span></span>
]] )</div>
<p class="para rdfs-comment">
Cuts a portion of <em><code class="parameter">str</code></em> specified by the
<em><code class="parameter">offset</code></em> and <em><code class="parameter">length</code></em> parameters.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.iconv-substr-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 original string.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">offset</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">offset</code></em> is non-negative,
<span class="function"><strong>iconv_substr()</strong></span> cuts the portion out of
<em><code class="parameter">str</code></em> beginning at <em><code class="parameter">offset</code></em>'th
character, counting from zero.
</p>
<p class="para">
If <em><code class="parameter">offset</code></em> is negative,
<span class="function"><strong>iconv_substr()</strong></span> cuts out the portion beginning
at the position, <em><code class="parameter">offset</code></em> characters
away from the end of <em><code class="parameter">str</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">length</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">length</code></em> is given and is positive, the return
value will contain at most <em><code class="parameter">length</code></em> characters
of the portion that begins at <em><code class="parameter">offset</code></em>
(depending on the length of <em><code class="parameter">string</code></em>).
</p>
<p class="para">
If negative <em><code class="parameter">length</code></em> is passed,
<span class="function"><strong>iconv_substr()</strong></span> cuts the portion out of
<em><code class="parameter">str</code></em> from the <em><code class="parameter">offset</code></em>'th
character up to the character that is
<em><code class="parameter">length</code></em> characters away from the end of the string.
In case <em><code class="parameter">offset</code></em> is also negative, the start position
is calculated beforehand according to the rule explained above.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">charset</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">charset</code></em> parameter is omitted,
<em><code class="parameter">string</code></em> are assumed to be encoded in
<a href="iconv.configuration.html" class="link">iconv.internal_encoding</a>.
</p>
<p class="para">
Note that <em><code class="parameter">offset</code></em> and <em><code class="parameter">length</code></em>
parameters are always deemed to represent offsets that are
calculated on the basis of the character set determined by
<em><code class="parameter">charset</code></em>, whilst the counterpart
<span class="function"><a href="function.substr.html" class="function">substr()</a></span> always takes these for byte offsets.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.iconv-substr-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the portion of <em><code class="parameter">str</code></em> specified by the
<em><code class="parameter">offset</code></em> and <em><code class="parameter">length</code></em> parameters.
</p>
<p class="para">
If <em><code class="parameter">str</code></em> is shorter than <em><code class="parameter">offset</code></em>
characters long, <strong><code>FALSE</code></strong> will be returned.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.iconv-substr-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.substr.html" class="function" rel="rdfs-seeAlso">substr()</a> - Return part of a string</span></li>
<li class="member"> <span class="function"><a href="function.mb-substr.html" class="function" rel="rdfs-seeAlso">mb_substr()</a> - Get part of string</span></li>
<li class="member"> <span class="function"><a href="function.mb-strcut.html" class="function" rel="rdfs-seeAlso">mb_strcut()</a> - Get part of 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.iconv-strrpos.html">iconv_strrpos</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.iconv.html">iconv</a></div>
<div class="up"><a href="ref.iconv.html">iconv Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
