array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'function.ini-get.php', 1 => 'ini_get', 2 => '設定オプションの値を得る', ), 'up' => array ( 0 => 'ref.info.php', 1 => 'PHP オプション/情報 関数', ), 'prev' => array ( 0 => 'function.ini-alter.php', 1 => 'ini_alter', ), 'next' => array ( 0 => 'function.ini-get-all.php', 1 => 'ini_get_all', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/info/functions/ini-get.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ini_get

(PHP 4, PHP 5, PHP 7, PHP 8)

ini_get — 設定オプションの値を得る

説明

ini_get(string $option): string|false

成功時に、設定オプションの値を返します。

パラメータ

option

設定オプションの名前。

戻り値

成功した場合に設定オプションの値、 null 値の場合は空の文字列を返します。 その設定オプションが存在しない場合は false を返します。

例

例1 ini_get() の例

<?php

/*
php.ini で以下のように設定されているものとします:

display_errors = On
opcache.enable_cli = Off
post_max_size = 8M
*/

echo 'display_errors = ' . ini_get('display_errors') . "\n";
echo 'opcache.enable_cli = ' . (int) ini_get('opcache.enable_cli') . "\n";
echo 'post_max_size = ' . ini_get('post_max_size') . "\n";
echo 'post_max_size + 1 = ' . (rtrim(ini_get('post_max_size'), 'KMG') + 1) . "\n";
echo 'post_max_size in bytes = ' . return_bytes(ini_get('post_max_size'));

?>

上の例の出力は、 たとえば以下のようになります。

display_errors = 1
opcache.enable_cli = 0
post_max_size = 8M
post_max_size+1 = 9
post_max_size in bytes = 8388608

注意

注意: boolean 値を探す場合

off という boolean の ini 値は空文字列または "0" として返されます。 一方で on の ini 値は "1" として返されます。 また、この関数はリテラル文字列で設定された INI 値を返すこともできます。

注意: メモリサイズの値を探す場合

upload_max_filesize のようなメモリサイズの値の場合、 php.ini上で省略形で格納されています。 ini_get()はphp.iniに格納されている値を そのままの形式で返します。整数表現に変換したりはしません。 これらの値に通常の算術的な関数を施すと予期しない結果になります。 短縮記法をバイトに変換する用途として、 ini_parse_quantity() が使えます。

注意:

ini_get() は、"配列" 形式の ini オプション (pdo.dsn.* など) を読むことができません。この場合は false を返します。

参考