Tutorials References Menu

PHP Tutorial

PHP HOME PHP Intro PHP Install PHP Syntax PHP Comments PHP Variables PHP Echo / Print PHP Data Types PHP Strings PHP Numbers PHP Math PHP Constants PHP Operators PHP If...Else...Elseif PHP Switch PHP Loops PHP Functions PHP Arrays PHP Superglobals PHP RegEx

PHP Forms

PHP Form Handling PHP Form Validation PHP Form Required PHP Form URL/E-mail PHP Form Complete

PHP Advanced

PHP Date and Time PHP Include PHP File Handling PHP File Open/Read PHP File Create/Write PHP File Upload PHP Cookies PHP Sessions PHP Filters PHP Filters Advanced PHP Callback Functions PHP JSON PHP Exceptions

PHP OOP

PHP What is OOP PHP Classes/Objects PHP Constructor PHP Destructor PHP Access Modifiers PHP Inheritance PHP Constants PHP Abstract Classes PHP Interfaces PHP Traits PHP Static Methods PHP Static Properties PHP Namespaces PHP Iterables

MySQL Database

MySQL Database MySQL Connect MySQL Create DB MySQL Create Table MySQL Insert Data MySQL Get Last ID MySQL Insert Multiple MySQL Prepared MySQL Select Data MySQL Where MySQL Order By MySQL Delete Data MySQL Update Data MySQL Limit Data

PHP XML

PHP XML Parsers PHP SimpleXML Parser PHP SimpleXML - Get PHP XML Expat PHP XML DOM

PHP - AJAX

AJAX Intro AJAX PHP AJAX Database AJAX XML AJAX Live Search AJAX Poll

PHP Examples

PHP Examples PHP Compiler

PHP Reference

PHP Overview PHP Array PHP Calendar PHP Date PHP Directory PHP Error PHP Exception PHP Filesystem PHP Filter PHP FTP PHP JSON PHP Keywords PHP Libxml PHP Mail PHP Math PHP Misc PHP MySQLi PHP Network PHP Output Control PHP RegEx PHP SimpleXML PHP Stream PHP String PHP Variable Handling PHP XML Parser PHP Zip PHP Timezones

PHP parse_ini_file() Function

❮ PHP Filesystem Reference

Example

Contents of "test.ini":

[names]
me = Robert
you = Peter

[urls]
first = "http://www.example.com"
second = "https://www.w3schools.com"

PHP code:

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

The output of the code above will be:

Array (
  [me] => Robert
  [you] => Peter
  [first] => http://www.example.com
  [second] => https://www.w3schools.com
)


Definition and Usage

The parse_ini_file() function parses a configuration (ini) file and returns the settings.

Tip: This function can be used to read in your own configuration files, and has nothing to do with the php.ini file.

Note: The following reserved words must not be used as keys for ini files: null, yes, no, true, false, on, off, none. Furthermore, the following reserved characters must not be used in the key: {}|&~!()^".

Syntax

parse_ini_file(file, process_sections, scanner_mode)

Parameter Values

Parameter Description
file Required. Specifies the ini file to parse
process_sections Optional. If set to TRUE, it returns is a multidimensional array with section names and settings included. Default is FALSE
scanner_mode

Optional. Can be one of the following values:

  • INI_SCANNER_NORMAL (default)
  • INI_SCANNER_RAW (means option values will not be parsed)
  • INI_SCANNER_TYPED (means that boolean, null and integer types are preserved when possible. "true", "on", "yes" are converted to TRUE. "false", "off", "no", "none" are converted to FALSE. "null" is converted to NULL. Numeric strings are converted to integer type if possible)


Technical Details

Return Value: An array on success, FALSE on failure
PHP Version: 4.0+
PHP Changelog: PHP 7.0: Hash marks (#) is no longer recognized as comments
PHP 5.6.1: Added INI_SCANNER_TYPED mode
PHP 5.3: Added optional scanner_mode parameter

More Examples

Example

Contents of "test.ini":

[names]
me = Robert
you = Peter

[urls]
first = "http://www.example.com"
second = "https://www.w3schools.com"

PHP code (with process_sections set to true):

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

The output of the code above will be:

Array
(
[names] => Array
  (
  [me] => Robert
  [you] => Peter
  )
[urls] => Array
  (
  [first] => http://www.example.com
  [second] => https://www.w3schools.com
  )
)


❮ PHP Filesystem Reference