ICONV_SUBSTR(3) 1 ICONV_SUBSTR(3)
iconv_substr - Cut out part of a string
SYNOPSIS
string iconv_substr (string $str, int $offset, [int $length = iconv_strlen($str, $charset)], [string $charset = ini_get("iconv.inter-
nal_encoding")])
DESCRIPTION
Cuts a portion of $str specified by the $offset and $length parameters.
PARAMETERS
o $str
- The original string.
o $offset
- If $offset is non-negative, iconv_substr(3) cuts the portion out of $str beginning at $offset'th character, counting from zero.
If $offset is negative, iconv_substr(3) cuts out the portion beginning at the position, $offset characters away from the end of
$str.
o $length
- If $length is given and is positive, the return value will contain at most $length characters of the portion that begins at
$offset (depending on the length of $string). If negative $length is passed, iconv_substr(3) cuts the portion out of $str from
the $offset'th character up to the character that is $length characters away from the end of the string. In case $offset is also
negative, the start position is calculated beforehand according to the rule explained above.
o $charset
- If $charset parameter is omitted, $string are assumed to be encoded in iconv.internal_encoding. Note that $offset and $length
parameters are always deemed to represent offsets that are calculated on the basis of the character set determined by $charset,
whilst the counterpart substr(3) always takes these for byte offsets.
RETURN VALUES
Returns the portion of $str specified by the $offset and $length parameters.
If $str is shorter than $offset characters long, FALSE will be returned.
SEE ALSO
substr(3), mb_substr(3), mb_strcut(3).
PHP Documentation Group ICONV_SUBSTR(3)
