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

<?php

/**
 * PHPのini_set関数を使って、スクリプトのメモリ制限を変更する方法を示すサンプルコードです。
 * ini_setで変更された設定は、現在のスクリプトの実行期間中のみ有効です。
 * PHP設定ファイル (php.ini) 自体を変更するわけではありません。
 */
function setScriptMemoryLimit(): void
{
    // 現在の 'memory_limit' の設定値を取得して表示します。
    // ini_get() は、指定された設定オプションの現在の値を返します。
    echo "現在の 'memory_limit': " . ini_get('memory_limit') . PHP_EOL;

    // 新しいメモリ制限を設定します。例えば '256M' (256メガバイト)
    $newMemoryLimit = '256M';

    // ini_set() を使って 'memory_limit' を新しい値に設定します。
    // 成功した場合、以前の値が文字列として返されます。
    // 失敗した場合 (例: セキュリティ制限など)、false が返されます。
    $oldMemoryLimit = ini_set('memory_limit', $newMemoryLimit);

    if ($oldMemoryLimit !== false) {
        echo "スクリプトの 'memory_limit' を '" . $newMemoryLimit . "' に設定しました。" . PHP_EOL;
        echo "以前の 'memory_limit': " . $oldMemoryLimit . PHP_EOL;
        // 変更が適用されたか確認するために、再度 'memory_limit' を取得して表示します。
        echo "新しい 'memory_limit': " . ini_get('memory_limit') . PHP_EOL;
    } else {
        echo "警告: 'memory_limit' を '" . $newMemoryLimit . "' に設定できませんでした。" . PHP_EOL;
        echo "現在の 'memory_limit' は依然として: " . ini_get('memory_limit') . PHP_EOL;
    }

    // 例として、非常に大きな配列を作成しようとしてメモリ使用量を確認できます。
    // ただし、このスクリプトは実際にメモリを大量に消費しません。
    // $largeArray = array_fill(0, 1024 * 1024 * 100, 'a'); // 100MBを消費する可能性のある例
}

// 関数を実行して、メモリ制限の変更処理を開始します。
setScriptMemoryLimit();

?>

PHPのini_set関数は、現在のスクリプトの実行期間中のみ、PHPの設定項目を動的に変更するために使用されます。これにより、php.iniファイルを直接編集することなく、特定のスクリプトの要件に合わせて一時的に設定を調整できます。

この関数は二つの引数を取ります。一つ目の$optionには変更したい設定項目の名前を文字列で指定し、二つ目の$valueにはその設定項目に割り当てる新しい値を、文字列、整数、浮動小数点数、真偽値、またはnullで指定します。例えば、サンプルコードではPHPが使用できるメモリの上限であるmemory_limitを'256M'に設定しています。

ini_set関数の実行に成功すると、変更前の設定値が文字列として返されます。セキュリティ上の制限などにより設定変更が許可されなかった場合は、falseが返されます。これにより、設定変更が正しく行われたかどうかを確認できます。変更が適用されたかどうかは、ini_get関数を使って再度設定値を取得することで確認できます。この変更は現在のスクリプトの実行期間中のみ有効で、他のスクリプトや次のHTTPリクエストには影響しません。