The php_sapi_name() function is extremely useful when you want to determine the type of interface. There is, however, one more gotcha you need to be aware of while designing your application or deploying it to an unknown server.
Whenever something depends on the type of interface, make sure your check is conclusive. Especially when you want to distinguish the command line interface (CLI) from the common gateway interface (CGI).
Note, that the php-cgi binary can be called from the command line, from a shell script or as a cron job as well! If so, the php_sapi_name() will always return the same value (i.e. "cgi-fcgi") instead of "cli" which you could expect.
Bad things happen to good people. Do not always expect /usr/bin/php to be a link to php-cli binary.
Luckily the contents of the $_SERVER and the $_ENV superglobal arrays depends on whether the php-cgi binary is called from the command line interface (by a shell script, by the cron, etc.) or by some HTTP server (i.e. lighttpd).
<?php
var_dump($_SERVER);
?>
Try to call php-cgi binary from the command line interface and then via HTTP request and compare the output of the script above. There will be plenty options to satisfy almost everyone.
For the sake of security remember, that contents of the $_SERVER and the $_ENV superglobal arrays (as well as $_GET, $_POST, $_COOKIE, $_FILES and $_REQUEST) should be considered tainted.
php_sapi_name
(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)
php_sapi_name — Retourne le type d'interface utilisée entre le serveur web et PHP
Description
Retourne une chaîne en minuscule qui décrit le type d'interface (l'API, SAPI serveur) que PHP utilise. Par exemple, en PHP CLI, cette chaîne sera "cli" tandis qu'avec Apache, elle pourra avoir plusieurs valeurs différentes suivant le SAPI exact utilisé. Les valeurs possibles sont listées ci-dessous.
Liste de paramètres
Cette fonction ne contient aucun paramètre.
Valeurs de retour
Retourne le type de l'interface, sous la forme d'une
chaîne de caractères en minuscule, ou false si une erreur survient.
Voici une liste non exhaustive des valeurs possibles :
apache,
apache2handler,
cgi (jusqu'en PHP 5.3),
cgi-fcgi, cli, cli-server,
embed, fpm-fcgi,
litespeed,
phpdbg.
Exemples
Exemple #1 Exemple avec php_sapi_name()
Cet exemple cherche la sous-chaîne cgi
car elle peut également valoir cgi-fcgi.
<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
echo "Vous utilisez CGI PHP\n";
} else {
echo "Vous n'utilisez pas CGI PHP\n";
}
?>Notes
Note: Une approche alternative
La constante PHP
PHP_SAPIa une valeur identique à php_sapi_name().
Astuce
Un comportement inattendu
Le SAPI défini ne doit pas être ambigu, car
par exemple, au lieu de apache, il peut être
défini à apache2handler.
add a note
User Contributed Notes 5 notes
michal at roszka dot pl ¶
15 years ago
hajo-p ¶
10 years ago
some not yet mentioned sapi names:
cli-server -> php built-in webserver
srv -> hhvm
Anonymous ¶
1 year ago
Note: When using Litespeed with CPanel, the SAPI will be "litespeed" and not contain "cgi".
michael at butlerpc dot net ¶
3 years ago
When using nginx-unit with PHP, the sapi name seems to be "cli-server"
