PHPのparse_ini_file()関数とは？INIファイルの読み方を解説

parse_ini_file()関数とは

PHPのparse_ini_file()関数は、設定ファイル（iniファイル）を解析（パース）し、その内容を配列として取得するための組み込み関数です。アプリケーションの設定を外部ファイルで管理したい場合などに便利です。

構文

parse_ini_file(file_path, process_sections)

パラメータ

• file_path − 解析対象となるiniファイルへのパスを指定します。

• process_sections − TRUEに設定すると、セクション名とその設定値を含んだ多次元配列が返されます。省略した場合のデフォルト値はFALSEです。

戻り値

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

例として、「demo.ini」の内容が以下のようになっているとします。

[names]
one = Anne
two = Katie
three = Tom
[urls]
host1 = "https://www.example1.com"
host2 = "https://www.example2.com"

使用例

<?php
    print_r(parse_ini_file("demo.ini"));
?>

出力結果

Array
(
    [one] => Anne
    [two] => Katie
    [three] => Tom
    [host1] => https://www.example1.com
    [host2] => https://www.example2.com
)

process_sectionsをTRUEにした場合

第2引数のprocess_sectionsをTRUEにすると、セクション名がキーとなった多次元配列で結果が取得できます。

<?php
    print_r(parse_ini_file("demo.ini", true));
?>

この場合、「names」や「urls」といったセクション名が配列のキーになり、各セクション内の設定値が階層的に整理されるため、セクションごとに設定を管理しやすくなります。