array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'function.register-shutdown-function.php', 1 => 'register_shutdown_function', ), 'up' => array ( 0 => 'ref.funchand.php', 1 => '関数処理 関数', ), 'prev' => array ( 0 => 'function.get-defined-functions.php', 1 => 'get_defined_functions', ), 'next' => array ( 0 => 'function.register-tick-function.php', 1 => 'register_tick_function', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/funchand/functions/register-shutdown-function.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4, PHP 5, PHP 7, PHP 8)
register_shutdown_function — シャットダウン時に実行する関数を登録する
スクリプト処理が完了したとき、あるいは exit() がコールされたときに実行するコールバック関数を登録します。
register_shutdown_function() は複数回コールする ことが可能で、登録された順に関数がコールされます。 登録した関数内で exit() をコールした場合、 処理はそこで終了してその他のシャットダウン関数はコールされません。
シャットダウン関数は、 別のシャットダウン関数をキューの最後に追加するために、 register_shutdown_function() そのものをコールしても構いません。
callback
登録するコールバック。
シャットダウン時のコールバックは、リクエストの一部として実行されます。 したがって、コールバック関数からも出力を送信できるし、出力バッファにもアクセスできます。
args
シャットダウン関数にパラメータを渡すには、ここで追加のパラメータを渡します。
値を返しません。
例1 register_shutdown_function() の例
<?php
function shutdown()
{
// これがシャットダウン関数で、
// スクリプトの処理が完了する前に
// ここで何らかの操作をすることができます
echo 'Script executed with success', PHP_EOL;
}
register_shutdown_function('shutdown');
?>
注意:
Apache などいくつかの Web サーバーでは、スクリプトの実行時ディレクトリを シャットダウン関数内で変更可能です。
注意:
SIGTERM あるいは SIGKILL でプロセスが終了した場合は、シャットダウン関数を実行しません。 SIGKILL を横取りすることはできませんが、SIGTERM 用のハンドラは pcntl_signal() で登録できます。ここで exit() を使えば、きれいに終わらせることができます。
注意:
シャットダウン関数は、 max_execution_time の経過とは別に実行されます。 つまり、プロセスが非常に長時間実行された後に終了しても、 シャットダウン関数はコールされます。 さらに、 シャットダウン関数を実行中に
max_execution_time
が経過しても、実行中の関数は終了しません。