cli_set_process_title

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

cli_set_process_title — Sets the process title

说明

cli_set_process_title ( string $title ) : bool

Sets the process title visible in tools such as top and ps. This function is available only in CLI mode.

参数

title: The new title.

返回值

成功时返回 true，或者在失败时返回 false。

错误／异常

An E_WARNING will be generated if the operating system is unsupported.

范例

Example #1 cli_set_process_title() example


<?php
$title = "My Amazing PHP Script";
$pid = getmypid(); // you can use this to see your process title in 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() - Returns the current process title
setproctitle()

User Contributed Notes

pitpat 17-Mar-2021 10:04


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).

Aurelien Marchand 01-Nov-2019 01:24


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



*/

aaron dot mason+php at thats-too-much dot info 08-Aug-2017 04:07


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.

code at edoceo dot com 12-Mar-2014 07:14


Setting proc title on PHP based daemons is pretty sweet.