部分文字列を返す

# grapheme_substr

(PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0)

grapheme_substr — 部分文字列を返す

### 説明

手続き型

grapheme_substr ( string `$string` , int `$start` [, int `$length` ] ) : string

部分文字列を返します。

### パラメータ

`string`

  入力文字列。正しい形式の UTF-8 でなければなりません。

`start`

  デフォルトの書記素単位での開始位置。 $start がゼロ以上である場合は、$string の $start 番目の位置から始まる文字列を返します。位置はゼロから数え始めます。 $start が負の場合は、文字列の末尾から数えて $start 番目 (書記素単位) の位置以降の文字列を返します。

`length`

  長さを書記素単位で指定します。 $length が正の値の場合は、$start から数えて最大 $length 文字までの文字列を返します (文字列全体の長さによって変わります)。 $length が負の値の場合は、文字列の末尾から多くの書記素が削除されます (start が負の場合にはまず開始位置を算出してから行います)。 $start がこの削除された場所以降になる場合は、`FALSE` を返します。

### 返り値

$string の部分文字列を返します。

### 変更履歴

バージョン | 説明
--- | ---
5.4 | `length` に正の値を指定して、 引数の文字列がその長さより短かった場合に、`start` に基づいて残りのすべての文字列を返すようになりました。 以前のバージョンでは `FALSE` を返していました。

### 例

例1 grapheme_substr() の例

`<?php
$char_a_ring_nfd = "a\xCC\x8A"; // 'LATIN SMALL LETTER A WITH RING ABOVE' (U+00E5) normalization form "D"
$char_o_diaeresis_nfd = "o\xCC\x88"; // 'LATIN SMALL LETTER O WITH DIAERESIS' (U+00F6) normalization form "D"
print urlencode(grapheme_substr( "ao" . $char_a_ring_nfd . "bc" . $char_o_diaeresis_nfd . "O", 2, -1 ));
?>`

上の例の出力は以下となります。

    a%CC%8Abco%CC%88

### 参考

- grapheme_extract() - デフォルトの書記素クラスタシーケンスをテキストバッファから取り出す関数。 テキストは UTF-8 でエンコードされている必要があります
- » Unicode Text Segmentation: Grapheme Cluster Boundaries