cli_set_process_title

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

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

説明

cli_set_process_title(string $title): bool

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

パラメータ

title

新しいタイトル。

戻り値

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

エラー / 例外

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

例1 cli_set_process_title() の例

<?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);
}
?>

参考

add a note

User Contributed Notes 5 notes

up
14
code at edoceo dot com
9 years ago
Setting proc title on PHP based daemons is pretty sweet.
up
1
pitpat
2 years ago
In Linux this command changes the title for commands like 'ps -a' it doesn't seem to work with 'top' or 'pkill'

To change the short name (eg PHP) to something else you can use the below:

<?php

$strNewName
='myscript';

cli_set_process_name($strNewName);
cli_set_process_title($strNewName);

var_dump(cli_get_process_name());
var_dump(cli_get_process_title());

function
cli_set_process_name($strName)
{
  
file_put_contents("/proc/".getmypid()."/comm",$strName);
}

function
cli_get_process_name()
{
  return(
trim(file_get_contents("/proc/".getmypid()."/comm"),"\r\n"));
}

Note: The above will NOT work in Windows and may not work in all flavours of linux (I use Debian).
up
0
Aurelien Marchand
3 years ago
Please note that the function might be inconsistent depending on your system.

On 2 of my systems (CentOS 7.7 and Linux Mint 18.3), setting the title will work for ps but not for top.

<?php
cli_set_process_title
("sleeping-daemon");
sleep(100);

/*
*ps* returns
25072 pts/2  S  0:00   sleeping-daemon

*top*  returns
25072 aurelien  20   0  285848  23256  16856 S   0.0  0.3   0:00.01 php

*/
up
0
aaron dot mason+php at thats-too-much dot info
5 years ago
In Windows, this function will set the Command Prompt window title, which is restored to the previous setting once the script finishes.  If you need to do this in 5.5.X and below, you'll need to use system() to run the title command.
up
-1
martin dot kratochvil at altnet dot cz
1 year ago
cli_set_process_title() change name only for some process manager in linux. In fact this function change value appear in /proc/self/cmdline and not value in /proc/self/comm. This value in comm file is used as name in #ps or #pstree and other process manager.

For changing proccess name completly in linux you could add after cli_set_process_title() this code:

$f = fopen('/proc/self/comm','w');
if ($f) { fwrite($f, 'my-new-app-name'); fclose($f);
To Top