関数・クラス解説

str_getcsv

version:PHP 5 >= 5.3.0, PHP 7 (公式)

CSV形式の文字列をパースし、配列で返却する

フォーマット

array : str_getcsv ( string $input [, string $delimiter = "," [, string $enclosure = '"' [, string $escape = "\\" ]]] )

パラメータ

string $input (必須)
CSV形式の文字列

string $delimiter = ","
フィールドの区切り文字を指定。デフォルトはカンマ(,)。1文字のみ有効

string $enclosure = '"'
フィールドデータの囲み文字を指定。デフォルトはダブルクオート(")。1文字のみ有効

string $escape = "\\"
エスケープ文字デフォルトはバックスラッシュ (\)。1文字のみ有効。空文字列 ("") を指定すると、 プロプライエタリなエスケープ機構を無効にします。

注意: 通常、enclosure の文字は、フィールドの中では二回出力されることでエスケープされます。しかし、escape の文字を代わりに使うこともできます。よって、デフォルト値 "" および \" は同じ意味になります。enclosure 文字をエスケープすることを許可する以外に、escape 文字は特別な意味を何ら持ちません; つまり、自分自身をエスケープすることすら意味しません。


返値 array
読み込んだフィールドの内容を配列で返します。

解説

CSV 形式の文字列入力のフィールドをパースして、 読み込んだフィールドの内容を配列で返します。


注意:
この関数はロケール設定を考慮します。もし LC_CTYPE が例えば en_US.UTF-8 の場合、1 バイトエンコーディングの文字列は間違って読み込まれるかもしれません。

記述サンプル

///PHP 7.4.6で実行

//CSV形式の文字列を指定
$input = '"12345","ABCDEF","abcdef","あいうえお"';

//実行
$result = str_getcsv($input);

//結果
print_r($result);
Array
(
    [0] => 12345
    [1] => ABCDEF
    [2] => abcdef
    [3] => あいうえお
)

//CSV形式の文字列を指定
$input = "12345 ABCDEF abcdef あ\ い\ うえお";

//実行
$result = str_getcsv($input, " ", "");

//結果
print_r($result);
Array
(
    [0] => 12345
    [1] => ABCDEF
    [2] => abcdef
    [3] => あ\
    [4] => い\
    [5] => うえお
)

参考リンク

fgetcsv ファイルポインタから行を取得し、CSVフィールドを処理する

タグ

csv パース 配列 String 文字列


公式リファレンス

書式

str_getcsv ( string $input [, string $delimiter = "," [, string $enclosure = '"' [, string $escape = "\\" ]]] ) : array

説明

CSV 形式の文字列入力のフィールドをパースして、 読み込んだフィールドの内容を配列で返します。

注意:

この関数はロケール設定を考慮します。もし LC_CTYPE が例えば en_US.UTF-8 の場合、 1 バイトエンコーディングの文字列は間違って読み込まれるかもしれません。

パラメータ

input
パースする文字列。
delimiter
フィールド区切り文字 (1 文字のみ)。
enclosure
フィールド囲み文字 (1 文字のみ)。
escape
エスケープ文字 (最大1文字)。デフォルトはバックスラッシュ (\)。 空文字列 ("") を指定すると、 プロプライエタリなエスケープ機構を無効にします。
注意: 通常、 enclosure の文字は、 フィールドの中では二回出力されることでエスケープされます。 しかし、escape の文字を代わりに使うこともできます。 よって、デフォルト値 "" および \" は同じ意味になります。 enclosure 文字をエスケープすることを許可する以外に、 escape 文字は特別な意味を何ら持ちません; つまり、自分自身をエスケープすることすら意味しません。

返値

読み込んだフィールドの内容を配列で返します。

更新履歴

バージョン 説明
7.4.0 escape 引数は、 空文字列を、プロプライエタリなエスケープ機構を無効にするシグナルとして解釈するようになりました。 これより前のバージョンでは、空文字列はデフォルト値のように扱われていました。

参考

  • fgetcsv() - ファイルポインタから行を取得し、CSVフィールドを処理する
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール