iconv_substr

Cut out part of a string.

iconv_substr Function synopsis

iconv_substr(
    string $string,
    int $offset,
    ?int $length = null,
    ?string $encoding = null
  ): string|false

Parameters

$string

Typestring

The original string.

$offset

Typeint

If $offset is non-negative, iconv_substr cuts the portion out of $string beginning at $offset'th character, counting from zero.

$length

OptionalType?intDefault valuenull

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).

$encoding

OptionalType?stringDefault valuenull

If $encoding parameter is omitted or null, $string are assumed to be encoded in iconv.internal_encoding.

Return value

Typestring|false

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.