iconv_substr
(PHP 5, PHP 7)
iconv_substr — Cut out part of a string
Description
$str
, int $offset
[, int $length
= iconv_strlen($str, $charset)
[, string $charset
= ini_get("iconv.internal_encoding")
]] ) : string
Cuts a portion of str
specified by the
offset
and length
parameters.
Parameters
-
str
-
The original string.
-
offset
-
If
offset
is non-negative, iconv_substr() cuts the portion out ofstr
beginning atoffset
'th character, counting from zero.If
offset
is negative, iconv_substr() cuts out the portion beginning at the position,offset
characters away from the end ofstr
. -
length
-
If
length
is given and is positive, the return value will contain at mostlength
characters of the portion that begins atoffset
(depending on the length ofstring
).If negative
length
is passed, iconv_substr() cuts the portion out ofstr
from theoffset
'th character up to the character that islength
characters away from the end of the string. In caseoffset
is also negative, the start position is calculated beforehand according to the rule explained above. -
charset
-
If
charset
parameter is omitted,string
are assumed to be encoded in iconv.internal_encoding.Note that
offset
andlength
parameters are always deemed to represent offsets that are calculated on the basis of the character set determined bycharset
, whilst the counterpart substr() 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.
If str
is exactly offset
characters long, an empty string will be returned.
Changelog
Version | Description |
---|---|
7.0.11 |
If str is equal to
offset characters long, an empty string will be
returned. Prior to this version, FALSE was returned in this case.
|
See Also
- substr() - Return part of a string
- mb_substr() - Get part of string
- mb_strcut() - Get part of string
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-iconv-substr.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.