【PHP8.x】memory_get_peak_usage関数の使い方
作成日: 更新日:
memory_get_peak_usage関数は、PHPスクリプトの実行開始から現在までに、割り当てられたメモリの中で最も多かったピーク時の使用量を取得するために使用される関数です。この関数を利用することで、スクリプトが一時的にどれくらいのメモリを必要とするのかを把握し、アプリケーションのメモリ使用状況を分析する手助けとなります。特に、大規模なデータ処理を行うスクリプトや、長時間稼働するサービスにおいて、メモリの効率的な管理や最適化、あるいはメモリリークの特定に役立ちます。
この関数は、オプションでreal_usageというブール型の引数を指定することができます。この引数を省略するかfalseに設定した場合、PHPが内部的に管理するメモリ（emalloc/efreeによって割り当てられたメモリ）のピーク使用量がバイト単位で返されます。これは、主にPHPスクリプトが直接的に使用するメモリの状況を示します。
一方、real_usage引数をtrueに設定すると、オペレーティングシステムから実際に割り当てられた物理メモリ全体のピーク使用量がバイト単位で返されます。これには、PHPエンジン自体が使用するメモリや、PHPの拡張機能などが割り当てたメモリも含まれるため、より広範囲なメモリ消費の状況を把握したい場合に有用です。返される値は常にバイト単位の整数値であり、この情報を活用することで、システムリソースを効果的に利用するための計画を立てることができます。
基本的な使い方
構文(syntax)
memory_get_peak_usage(bool $real_usage = false): int
引数(parameters)
bool $real_usage = false
- bool $real_usage = false: 実際のメモリ使用量（ハードウェアレベル）を取得するかどうかを示すブール値。デフォルトは
falseで、PHPのメモリ使用量を取得します。
戻り値(return)
int
この関数は、PHPスクリプトが実行されている間に消費されたメモリの最大量をバイト単位で返します。