PHP - Manual: php_sapi_name

2024-11-13

php_uname »

« php_ini_scanned_files

php_sapi_name

(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)

php_sapi_name — 返回 web 服务器和 PHP 之间的接口类型

说明

php_sapi_name(): string|false

返回描述 PHP 所使用的接口类型（the Server API, SAPI）的小写字符串。例如，CLI 的 PHP 下这个字符串会是 "cli"，Apache 下可能会有几个不同的值，取决于具体使用的 SAPI。以下列出了可能的值。

返回值

返回接口类型的小写字符串，或者在失败时返回 false。

尽管不够全面，可能返回的值包括了 apache、 apache2handler、 cgi （直到 PHP 5.3）, cgi-fcgi、cli、 cli-server、 embed、fpm-fcgi、 litespeed、 nsapi、phpdbg。

范例

示例 #1 php_sapi_name() 例子

以下例子检测了子字符串 cgi，因为它也有可能会是 cgi-fcgi。


<?php
$sapi_type = php_sapi_name();
if (substr($sapi_type, 0, 3) == 'cgi') {
    echo "You are using CGI PHP\n";
} else {
    echo "You are not using CGI PHP\n";
}
?>

注释

注意: 另一种方法
PHP 常量 PHP_SAPI 具有和 php_sapi_name() 相同的值。

小技巧

一个潜在的疑难问题

定义的 SAPI 可能不够明显，比如它可能定义为 apache2handler，而不是 apache。

参见

PHP_SAPI

add a note

User Contributed Notes 4 notes

down

michal at roszka dot pl ¶

13 years ago


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.

down

hajo-p ¶

8 years ago


some not yet mentioned sapi names:

cli-server -> php built-in webserver
srv -> hhvm

down

-2

michael at butlerpc dot net ¶

1 year ago


When using nginx-unit with PHP, the sapi name seems to be "cli-server"

down

-30

anonymous ¶

6 years ago


php_sapi_name (which is equal to PHP_SAPI) can either be cgi or any other cgi mod (dependent on which mod you are using)-

Examples: 
'fpm-fcgi'
'cgi-fcgi'
[...]

add a note

官方地址：https://www.php.net/manual/en/function.php-sapi-name.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络 JAVA NoSQL 数据库面试 C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet ADORecordSet对象 adodb手册 PHP 8.1 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 opcache预加载 Composer的Packagist资源 mysql面试题 [鸟哥]PHP FFI详解 - 一种全新的PHP扩展方式 PHP7添加redis扩展 PHP mkdir()写出来的权限与mode值不符合 Packagist / Composer 中国全量镜像 PHPstorm 里面Terminal 不能使用 esc键吗退出编辑模式吗利用php soap实现web service [原创]诡异的php-fpm超时问题

略微加速

PHP官方手册 - 互联网笔记

php_sapi_name

说明

返回值

范例

注释

一个潜在的疑难问题

参见

User Contributed Notes 4 notes