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
と定義されることもあります。