PHP parse_ini_file Function
last modified April 3, 2025
The PHP parse_ini_file function parses a configuration INI file and
returns its contents as an associative array. It's useful for reading configs.
Basic Definition
The parse_ini_file function reads an INI file and returns its
settings in an array. It supports sections, arrays, and various value types.
Syntax: parse_ini_file(string $filename, bool $process_sections = false, int $scanner_mode = INI_SCANNER_NORMAL): array|false.
Basic parse_ini_file Example
This shows the simplest usage of parse_ini_file to read a config.
<?php
declare(strict_types=1);
$config = parse_ini_file('config.ini');
print_r($config);
This reads "config.ini" and returns its contents as an associative array. The file must be in the same directory or provide a full path.
INI File with Sections
When processing sections, the function returns a multidimensional array.
<?php
declare(strict_types=1);
$config = parse_ini_file('config.ini', true);
print_r($config);
With the second parameter set to true, section names become array keys. Each section's settings are stored in a sub-array under its name.
Handling Different Value Types
parse_ini_file automatically converts values to appropriate types.
<?php
declare(strict_types=1);
$config = parse_ini_file('types.ini');
var_dump($config);
The function converts "true"/"on"/"yes" to boolean true, and "false"/"off"/"no" to false. Numbers become integers or floats, others remain strings.
INI_SCANNER_TYPED Mode
The scanner mode parameter provides more control over type conversion.
<?php
declare(strict_types=1);
$config = parse_ini_file('config.ini', false, INI_SCANNER_TYPED);
var_dump($config);
INI_SCANNER_TYPED mode preserves original string values that look like numbers. This prevents automatic conversion of numeric strings to integers or floats.
Working with Arrays
INI files can define arrays using square brackets or repeated keys.
<?php
declare(strict_types=1);
$config = parse_ini_file('arrays.ini');
print_r($config);
Array values can be defined as key[] = value or key[0] = value.
The function combines these into proper PHP arrays in the result.
Best Practices
- Error Handling: Always check if the file exists first.
- Security: Validate INI file paths to prevent directory traversal.
- Performance: Cache parsed results for frequently accessed files.
- Validation: Verify required settings exist after parsing.
Source
PHP parse_ini_file Documentation
This tutorial covered the PHP parse_ini_file function with practical
examples showing its usage in different scenarios.