php_sapi_name

FunctionReturn type changed in PHP 8.0

Returns the type of interface between web server and PHP.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

php_sapi_name Function synopsis

php_sapi_name(): string|false

Parameters

php_sapi_name does not take any parameters.

Return value

Typestring|false

Returns the interface type, as a lowercase string, or false on failure.

Although not exhaustive, the possible return values include apache, apache2handler, cgi (until PHP 5.3), cgi-fcgi, cli, cli-server, embed, fpm-fcgi, litespeed, phpdbg.

php_sapi_name returns one of the following string values:

  • aolserver
  • apache
  • apache2filter
  • apache2handler
  • caudium
  • cgi-fcgi
  • cli
  • cli-server
  • continuity
  • embed
  • fpm-fcgi
  • isapi
  • litespeed
  • milter
  • nsapi
  • phpdbg
  • phttpd
  • pi3web
  • roxen
  • thttpd
  • tux
  • webjames

Changes to the php_sapi_name Function

PHP 8.0

  • Return type added: string|false
- php_sapi_name()
+ php_sapi_name(): string|false

php_sapi_name Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes