(PHP 4, PHP 5, PHP 7, PHP 8)
exec — Execute an external program
$command, array &$output = null, int &$result_code = null): string|false
exec() executes the given
command.
commandThe command that will be executed.
output
If the output argument is present, then the
specified array will be filled with every line of output from the
command. Trailing whitespace, such as \n, is not
included in this array. Note that if the array already contains some
elements, exec() will append to the end of the array.
If you do not want the function to append elements, call
unset() on the array before passing it to
exec().
result_code
If the result_code argument is present
along with the output argument, then the
return status of the executed command will be written to this
variable.
The last line from the result of the command. If you need to execute a command and have all the data from the command passed directly back without any interference, use the passthru() function.
Returns false on failure.
To get the output of the executed command, be sure to set and use the
output parameter.
Example #1 An exec() example
<?php
// outputs the username that owns the running php/httpd process
// (on a system with the "whoami" executable in the path)
$output=null;
$retval=null;
exec('whoami', $output, $retval);
echo "Returned with status $retval and output:\n";
print_r($output);
?>
The above example will output something similar to:
Returned with status 0 and output:
Array
(
[0] => cmb
)
When allowing user-supplied data to be passed to this function, use escapeshellarg() or escapeshellcmd() to ensure that users cannot trick the system into executing arbitrary commands.
Note:
If a program is started with this function, in order for it to continue running in the background, the output of the program must be redirected to a file or another output stream. Failing to do so will cause PHP to hang until the execution of the program ends.
Note:
On Windows exec() will first start cmd.exe to launch the command. If you want to start an external program without starting cmd.exe use proc_open() with the
bypass_shelloption set.