iconv_substr
(PHP 5, PHP 7, PHP 8)
iconv_substr — Cut out part of a string
Description
string
$string
,int
$offset
,?int
$length
= null
,?string
$encoding
= null
): string|false
Cuts a portion of string
specified by the
offset
and length
parameters.
Parameters
-
string
-
The original string.
-
offset
-
If
offset
is non-negative, iconv_substr() cuts the portion out ofstring
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 ofstring
. -
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 ofstring
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. -
encoding
-
If
encoding
parameter is omitted ornull
,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 byencoding
, whilst the counterpart substr() always takes these for byte offsets.
Return Values
Returns the portion of string
specified by the
offset
and length
parameters.
If string
is shorter than offset
characters long, false
will be returned.
If string
is exactly offset
characters long, an empty string will be returned.
Changelog
Version | Description |
---|---|
8.0.0 |
length and encoding are nullable now.
|
7.0.11 |
If string 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