【PHP8.x】get_cfg_var関数の使い方

get_cfg_var関数は、PHPの設定変数の値を取得する関数です。この関数は、主にPHPが起動する際に読み込まれる「php.ini」ファイルで定義されている設定オプションの値を参照します。例えば、PHPスクリプトの実行時間の上限やメモリの使用量など、PHP環境の初期設定をプログラムの中から確認したい場合に利用できます。

引数には、取得したい設定オプションの名前を文字列で指定します。指定したオプションが存在し、値が設定されている場合はその値を返しますが、設定されていない場合は論理値のfalseを返します。

特に重要なのは、この関数が「php.ini」ファイルに直接記述された値のみを対象とする点です。プログラムの実行中にini_set()関数などを用いて一時的に変更された設定値や、ウェブサーバーの設定などによって上書きされた値は、この関数では取得できません。それらの実行時設定値も含めて確認したい場合は、ini_get()関数を使用する必要があります。

get_cfg_var関数は、PHPの初期設定が意図した通りにロードされているかを確認したり、システム全体のデフォルト設定を把握したりする際に特に役立ちます。これにより、アプリケーションの安定稼働に必要な環境設定を正確に理解し、デバッグやシステム管理に活用できます。

<?php
$option_name = 'memory_limit';
$option_value = get_cfg_var($option_name);

if ($option_value !== false) {
    echo $option_name . ': ' . $option_value;
} else {
    echo $option_name . ' は設定されていません。';
}

string $option

• string $option: 取得したい設定オプションの名前を指定する文字列

array|string|false

指定された設定項目に対応する値、または設定項目が見つからなかった場合は false を返します。