【PHP8.x】php_sapi_name関数の使い方

Copy
1<?php
2
3/**
4 * 現在のPHP SAPI (Server Application Programming Interface) の名前を出力します。
5 *
6 * php_sapi_name() 関数は、PHPが現在どのような環境で実行されているかを示すSAPIの名前を文字列で返します。
7 * 例えば、Webサーバーのモジュール（例: Apacheのmod_php）として実行されていれば 'apache2handler'、
8 * NginxなどのFastCGIプロセスとして実行されていれば 'fpm-fcgi'、
9 * コマンドラインから実行されていれば 'cli' などが返されます。
10 *
11 * この関数は引数をとりません。
12 */
13function showCurrentSapiName(): void
14{
15    // php_sapi_name() 関数を呼び出し、現在のSAPI名を取得します。
16    // この関数が、"php_sapi"（SAPIの概念）の具体的な"名前"を返します。
17    $sapiName = php_sapi_name();
18
19    echo "現在のPHP SAPI (Server Application Programming Interface) の名前: '{$sapiName}'\n";
20    echo "この情報は、PHPがWebサーバー経由（例: apache2handler, fpm-fcgi）\n";
21    echo "またはコマンドライン（例: cli）でどのように動作しているかを示します。\n";
22}
23
24// 関数を実行し、SAPI名を表示します。
25showCurrentSapiName();
26
27?>

PHPのphp_sapi_name関数は、現在PHPがどのような環境で実行されているかを示す「SAPI」の名前を取得するために使用されます。SAPIとは「Server Application Programming Interface」の略で、PHPがWebサーバー（ApacheやNginxなど）やコマンドラインといった異なる環境とどのように連携するかを定義するインターフェースのことです。

この関数は引数を一切必要とせず、現在のSAPIの名前を文字列として返します。例えば、WebサーバーのApacheモジュールとしてPHPが動作していれば「apache2handler」、NginxなどのWebサーバーと連携するFastCGIプロセスとして動作していれば「fpm-fcgi」、あるいはコマンドラインからスクリプトを実行していれば「cli」といった文字列が戻り値として得られます。

提供されたサンプルコードでは、php_sapi_name()関数を呼び出すことで、現在のPHPのSAPI名を取得し、それを画面に出力しています。この情報を見ることで、PHPがWebサーバー経由で動いているのか、それともコマンドラインツールとして実行されているのかを具体的に把握することが可能です。このように、php_sapi_name関数は、PHPの実行環境をプログラムで判断し、それに応じた処理を切り替える際に役立つ基本的な関数です。