PHPのparse_ini_string()関数とは？構文・パラメータ・使用例を解説

PHPのparse_ini_string()関数は、INI形式で記述された設定文字列を解析するための関数です。解析に成功すると、設定内容を連想配列として返し、失敗した場合はFALSE（false）を返します。

なお、INIファイルを直接読み込んで解析したい場合はparse_ini_file()関数を使用します。parse_ini_string()が「文字列」を対象とするのに対し、parse_ini_file()は「ファイル」を対象とする点が大きな違いです。用途に応じて使い分けるとよいでしょう。

構文

parse_ini_string(ini, process_sections, scanner_mode)

パラメータ

• ini − 解析対象となるINI形式の設定文字列を指定します。

• process_sections − TRUEを指定すると、セクション名とその中の設定が含まれた多次元配列として結果を取得できます。省略した場合のデフォルト値はFALSEです。

• scanner_mode − 省略可能なパラメータです。INI_SCANNER_NORMAL（通常モード）やINI_SCANNER_RAW（引用符などを解釈せず生の値をそのまま返すモード）など、スキャナの動作モードを指定できます。

戻り値

parse_ini_string()関数は、解析に成功した場合に設定内容を連想配列として返します。失敗した場合はFALSEを返します。

ここで、次のようなINI形式の設定文字列を例に考えてみましょう。

[names]
one = Anne

[urls]
host1 = "https://www.example1.com"

使用例

<?php
   $ini = "[names]\none = Anne\n\n[urls]\nhost1 = \"https://www.example1.com\"";
   print_r(parse_ini_string($ini));
?>

出力結果

Array
(
   [one] => Anne
   [host1] => https://www.example1.com
)

このように、process_sectionsを指定しない（FALSEの）場合、セクション名は無視され、すべての設定項目がひとつの連想配列にまとめられて返されます。セクションごとに分けて取得したい場合は、第2引数にTRUEを渡してください。