Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】CURLOPT_PATH_AS_IS定数の使い方

CURLOPT_PATH_AS_IS定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

CURLOPT_PATH_AS_IS定数は、PHPのcURL拡張機能で利用される定数です。これは、cURLがHTTPリクエストを送信する際に、指定されたURLのパス部分をどのように処理するかを制御するために使用されます。

通常、cURLライブラリは、CURLOPT_URLオプションで指定されたURLに含まれるパス要素を自動的に正規化します。この正規化処理には、例えば「/./」のような現在のディレクトリを示すセグメントや、「/../」のような親ディレクトリを示すセグメントの解決、さらに複数の連続したスラッシュ(例:「//」)の除去などが含まれます。これは、多くの場合、意図しないパス解釈を防ぎ、より標準的なURL形式に変換するために役立ちます。

しかし、CURLOPT_PATH_AS_IS定数をtrueに設定すると、この自動的なパス正規化処理を無効にすることができます。これにより、CURLOPT_URLオプションで指定されたURLのパス部分が、記述された文字通りの状態でサーバーに送信されるようになります。このオプションは、Webサーバーが意図的に正規化されていないパスを受け入れるように設計されている場合や、特定のパス構造がそのままの形で必要とされる特殊なケースで役立ちます。例えば、特定のWebアプリケーションが、パス内のドットセグメント(「.」や「..」)を特別な意味で解釈するような場合に有用です。この定数を使用する際は、セキュリティ上の側面や、サーバー側のパス解釈ロジックを十分に理解していることが重要です。

構文(syntax)

1<?php
2
3$ch = curl_init();
4
5// CURLOPT_PATH_AS_IS の使用例
6// URL に含まれるパスが、エンコードされた形式(例: %2F)のままでサーバーに送信されます。
7// デフォルトでは、cURL は一部のエンコードされた文字(例: %2F -> /)をデコードして送信します。
8curl_setopt($ch, CURLOPT_URL, "https://example.com/api/v1/foo%2Fbar");
9curl_setopt($ch, CURLOPT_PATH_AS_IS, true); // ここが CURLOPT_PATH_AS_IS の構文
10
11curl_exec($ch);
12curl_close($ch);
13
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

CURLOPT_PATH_AS_IS は、FTP でのパスの指定方法を制御するための定数です。この定数を指定すると、URL のパス部分がそのまま使用され、URL エンコードされなくなります。

関連コンテンツ