cli_set_process_title

(PHP 5 >= 5.5.0, PHP 7)

cli_set_process_titleSets the process title

Description

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.

Parameters

title

The new title.

Return Values

Returns TRUE on success or FALSE on failure.

Errors/Exceptions

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

Examples

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

See Also

add a note add a note

User Contributed Notes 4 notes

up
10
code at edoceo dot com
5 years ago
Setting proc title on PHP based daemons is pretty sweet.
up
1
aaron dot mason+php at thats-too-much dot info
2 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
0
Aurelien Marchand
1 month 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
-5
MJ
3 years ago
Beware that if you kill the process via console the original command line will appear.
To Top