cli_set_process_title

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

cli_set_process_title — プロセスのタイトルを設定する

説明

function cli_set_process_title(string $title): bool

プロセスのタイトルを設定します。これは top や ps といったツールで表示されます。この関数は、 CLI モードでしか使えません。

パラメータ

title: 新しいタイトル。

戻り値

成功した場合に true を、失敗した場合に false を返します。

エラー / 例外

OS がこの機能に対応していない場合に E_WARNING が発生します。

変更履歴

バージョン	説明
8.5.0	長すぎるプロセスのタイトルを設定しようとすると、 cli_set_process_title() は `E_WARNING` を発生させるようになりました。以前は、タイトルは切り詰められていました。

例

<?php
$title = "My Amazing PHP Script";
$pid = getmypid(); // これを使えば、プロセスのタイトルを ps で確認できます

if (!cli_set_process_title($title)) {
    echo "Unable to set process title for PID $pid...\n";
    exit(1);
} else {
    echo "The process title '$title' for PID $pid has been set for your process!\n";
    sleep(5);
}
?>

参考

cli_get_process_title() - 現在のプロセスのタイトルを返す