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 — ウェブサーバーと PHP の間のインターフェイスの型を返す
説明
PHP が使用しているインターフェイス (サーバー API、SAPI) の型を小文字の文字列で返します。たとえば、CLI 版の PHP ではこの文字列は "cli" となります。Apache と組み合わせて使用している場合は、 実際に使用している SAPI によってさまざまな結果となります。 返されうる値の一覧を以下にあげます。
パラメータ
この関数にはパラメータはありません。
戻り値
インターフェイスの型を小文字の文字列で返します。
失敗した場合に false を返します
これがすべてではありませんが、以下のような値が返されます。
apache,
apache2handler,
cgi (PHP 5.3 まで),
cgi-fcgi, cli, cli-server,
embed, fpm-fcgi,
litespeed,
phpdbg
例
例1 php_sapi_name() の例
この例では、文字列の一部に cgi
が含まれるかどうかを調べています。というのも
cgi-fcgi となることもあり得るからです。
<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
echo "CGI 版の PHP を使用しています\n";
} else {
echo "CGI 版の PHP を使用していません\n";
}
?>注意
注意: 別の方法
PHP の定数
PHP_SAPIは、 php_sapi_name() と同じ値となります。
ヒント
失敗しがちな点
定義されている SAPI は、わかりやすいものばかりではないかもしれません。
たとえば apache の場合は
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"
