iconv_substr

(PHP 5, PHP 7)

iconv_substr — 文字列の一部を切り出す

説明

iconv_substr ( string $str , int $offset [, int $length = iconv_strlen($str, $charset) [, string $charset = ini_get("iconv.internal_encoding") ]] ) : string

文字列 str の、 offset と length で指定された一部を返します。

パラメータ

str

元の文字列。

offset

offset が負でない場合、 iconv_substr() は str の offset 番目の文字（ゼロから数えて）から切り出します。

offset が負の場合、 iconv_substr() は str の最後から数えて offset 番目の文字から切り出します。

length

length が指定され、かつ正である場合、 返される文字列は offset から数えて最大 length 文字数分となります (string の長さに依存します)。

もし負の length が渡された場合に iconv_substr() が切り出す文字列は、 str の offset 番目の文字からはじまり、文字列の最後から数えて length 文字分戻ったところまでとなります。 offset も負の場合、開始位置は 上で説明した方式で計算されます。

charset

charset が指定されなかった場合、文字セットは ini 設定 iconv.internal_encoding で定義された値とみなされます。

offset や length のパラメータは、常に charset で定義された 文字セットにおける文字数と判断されることに注意してください。 一方、substr() の場合はこれらの値を常に バイト数として判断します。

返り値

文字列 str の、 offset と length で指定された一部を返します。

もし str が offset の文字列長より短い場合は、FALSE が返されます。 If str is exactly offset characters long, an empty string will be returned.

変更履歴

バージョン 説明
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.

参考