【PHP8.x】preg_last_error()関数の使い方
preg_last_error関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
preg_last_error関数は、直前に実行された正規表現(PCRE)関数のエラーコードを取得する関数です。PHPで提供されるpreg_matchやpreg_replaceといった正規表現関連の関数が何らかの理由で正常に処理されなかった場合に、その失敗の原因を具体的に特定するために利用されます。
この関数は、正規表現処理中にエラーが一切発生しなかった場合はPCRE_ERROR_NONE(整数値の0)を返します。もし何らかのエラーが発生した場合は、その種類を示す特定の整数値が返されます。例えば、正規表現パターンに文法的な誤りがあった場合はPCRE_ERROR_BADPATT、正規表現の処理に必要なメモリが不足した場合はPCRE_ERROR_NOMEMORYといったコードが返されます。これらのエラーコードは、正規表現処理がなぜ意図通りに進まなかったのかを具体的に示します。
システムエンジニアを目指す方にとって、プログラムの予期せぬ動作の原因を突き止め、適切に対処する能力は非常に重要です。正規表現は強力な機能である一方で記述が複雑になりがちで、意図しないエラーが発生する可能性も少なくありません。preg_last_error関数を活用することで、そうした正規表現関連の問題をデバッグし、適切なエラーハンドリングを実装することが可能になります。返されるエラーコードの詳細な意味や、他のエラーコードの一覧については、PHPの公式ドキュメントにあるPCRE定数の項目を参照することをお勧めします。この関数は、より堅牢で信頼性の高い正規表現処理を実装するために不可欠なツールです。
構文(syntax)
1<?php 2$error_code = preg_last_error(); 3?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
int
正規表現関数(preg_*)の実行で発生した最後のエラーコードを整数で返します。エラーが発生しなかった場合は 0 (PREG_NO_ERROR) を返します。
サンプルコード
preg_last_error で正規表現エラーコードを取得する
1<?php 2 3/** 4 * preg_last_error() の使用例。 5 * 無効な正規表現パターンを使ってエラーを発生させ、そのエラーコードを取得・表示します。 6 * システムエンジニアを目指す初心者向けに、正規表現処理のエラーハンドリングの基本を示します。 7 */ 8 9// 無効な正規表現パターンを定義します。 10// 例: 開き括弧があるのに閉じ括弧がないため、PCREによって無効なパターンと判断されます。 11$invalidPattern = '/([a-z)/'; 12 13// 意図的に正規表現エラーを発生させます。 14// preg_match 関数は、この無効なパターンに対して false を返し、PHP は通常警告を生成します。 15// ここでは @ 演算子を使って警告の出力を一時的に抑制し、 16// preg_last_error() の結果に集中できるようにしています。 17@preg_match($invalidPattern, 'sample text'); 18 19// 直近のPCRE正規表現操作で発生したエラーのコードを取得します。 20// エラーが発生していない場合は PREG_NO_ERROR (0) が返されます。 21$errorCode = preg_last_error(); 22 23echo "直近のPCREエラーコード: " . $errorCode . PHP_EOL; 24 25// 取得したエラーコードに基づいて、具体的なエラーメッセージを表示します。 26// これにより、どのような種類の正規表現エラーが発生したかを特定できます。 27switch ($errorCode) { 28 case PREG_NO_ERROR: 29 echo "PREG_NO_ERROR: 正規表現処理でエラーは発生していません。" . PHP_EOL; 30 break; 31 case PREG_INTERNAL_ERROR: 32 echo "PREG_INTERNAL_ERROR: PCRE内部エラーが発生しました。" . PHP_EOL; 33 break; 34 case PREG_BACKTRACK_LIMIT_ERROR: 35 echo "PREG_BACKTRACK_LIMIT_ERROR: バックトラック回数制限を超過しました。" . PHP_EOL; 36 break; 37 case PREG_RECURSION_LIMIT_ERROR: 38 echo "PREG_RECURSION_LIMIT_ERROR: 再帰回数制限を超過しました。" . PHP_EOL; 39 break; 40 case PREG_BAD_UTF8_ERROR: 41 echo "PREG_BAD_UTF8_ERROR: 不正なUTF-8シーケンスが検出されました。" . PHP_EOL; 42 break; 43 case PREG_BAD_UTF8_OFFSET_ERROR: 44 echo "PREG_BAD_UTF8_OFFSET_ERROR: UTF-8オフセットエラーが発生しました。" . PHP_EOL; 45 break; 46 case PREG_JIT_STACKLIMIT_ERROR: // PHP 7.0.0 以降で利用可能 47 echo "PREG_JIT_STACKLIMIT_ERROR: JITスタック制限を超過しました。" . PHP_EOL; 48 break; 49 default: 50 echo "不明なPCREエラーコード (" . $errorCode . ") が検出されました。" . PHP_EOL; 51 break; 52}
PHPのpreg_last_error関数は、直前に行われたPCRE(Perl互換正規表現)関連の操作で発生したエラーのコードを取得するために使用されます。この関数は引数を取りません。戻り値として、エラーの種類を示す整数値(int)を返します。エラーが全く発生していない場合は、定数PREG_NO_ERROR(値は0)が返されます。
このサンプルコードは、システムエンジニアを目指す初心者の方向けに、正規表現のエラーハンドリングの基本を示しています。まず、意図的に閉じ括弧がない無効な正規表現パターンを定義し、preg_match関数で処理しようとすることで、PCREエラーを発生させています。@演算子で警告メッセージを抑制した後、preg_last_error()を呼び出すことで、そのエラーの種類を示すコード(整数値)を取得しています。
取得されたエラーコードは、PREG_INTERNAL_ERRORやPREG_BAD_UTF8_ERRORといったPHPの定義済み定数と比較することで、どのような問題が発生したのかを具体的に特定できます。これにより、正規表現が原因でプログラムが予期せぬ動作をするのを防ぎ、エラーに応じた適切な処理やデバッグを行うことが可能になります。正規表現を安全に扱う上で、この関数によるエラー検出は非常に重要です。
このサンプルコードでは、@演算子で警告メッセージの出力を一時的に抑制していますが、本番環境ではエラーを隠蔽せず、ログに出力するか例外処理を行うべきです。preg_last_error()は、preg_matchなどの正規表現関数が失敗した直後に呼び出すことで、エラーの原因を具体的に特定する際に非常に役立ちます。エラーコードは、PREG_NO_ERRORなどのPHP定数と比較して意味を判断してください。これにより、不正なパターンや処理制限超過といった問題を早期に検出し、堅牢なシステム構築に繋がります。適切なエラーハンドリングは、安定したアプリケーション開発の基本となります。
preg_last_error_msg で正規表現エラーを取得する
1<?php 2 3/** 4 * preg_last_error および preg_last_error_msg の使用例を示します。 5 * 正規表現関数の実行後に発生したエラーコードとエラーメッセージを取得する方法を 6 * システムエンジニアを目指す初心者向けに解説します。 7 */ 8function demonstratePregErrors(): void 9{ 10 echo "--- 正規表現エラーのデモンストレーション ---\n\n"; 11 12 // 1. 意図的に正規表現エラーを発生させる例 13 // このパターンは閉じ括弧が不足しているため、PCREによって構文エラーとして扱われます。 14 // preg_match() の戻り値 (false) を確認し、その後に preg_last_error() で詳細を取得するのが一般的です。 15 $errorPattern = '/(unclosed_group_pattern/'; 16 $subject = 'sample text'; 17 $matches = []; 18 19 echo "不正な正規表現パターンを試行: '$errorPattern'\n"; 20 // @ は警告メッセージが直接出力されるのを防ぎ、preg_last_error で後からエラーをチェックできるようにします。 21 $result = @preg_match($errorPattern, $subject, $matches); 22 23 // preg_match() の戻り値が false の場合、正規表現の実行に失敗したことを示します。 24 if ($result === false) { 25 echo "=> preg_match() 関数自体が失敗を返しました。\n"; 26 } elseif ($result === 0) { 27 echo "=> パターンが見つかりませんでした (エラーではない)。\n"; 28 } else { 29 echo "=> パターンが見つかりました。\n"; 30 } 31 32 // 2. preg_last_error() で最後のエラーコードを取得 33 // 戻り値は整数値で、どの種類のエラーが発生したかを示します。 34 // 例: PREG_NO_ERROR (0), PREG_INTERNAL_ERROR (1) など。 35 $errorCode = preg_last_error(); 36 37 // 3. preg_last_error_msg() で最後のエラーメッセージを取得 (PHP 8.0 以降) 38 // 戻り値は文字列で、エラーコードに対応する人間が読めるメッセージです。 39 $errorMessage = preg_last_error_msg(); 40 41 echo "\n--- エラー詳細 ---\n"; 42 echo "preg_last_error() が返したエラーコード: " . $errorCode . "\n"; 43 echo "preg_last_error_msg() が返したエラーメッセージ: " . $errorMessage . "\n"; 44 45 // エラーコードが PREG_NO_ERROR (0) でない場合、明示的な正規表現エラーがあったことを示します。 46 if ($errorCode !== PREG_NO_ERROR) { 47 echo "=> preg_last_error() は正規表現処理中にエラーを検出しました。\n"; 48 } else { 49 // 注: 構文エラーなど一部のケースでは、preg_last_error() が PREG_NO_ERROR を返しても 50 // preg_match() が false を返すことがあります。両方確認することが重要です。 51 echo "=> preg_last_error() はエラーを検出しませんでした。\n"; 52 } 53 echo "--------------------\n\n"; 54 55 // 4. エラーが発生しない場合 56 $validPattern = '/valid_pattern/'; 57 $validSubject = 'This is a valid_pattern example.'; 58 59 echo "有効な正規表現パターンを試行: '$validPattern'\n"; 60 $resultValid = preg_match($validPattern, $validSubject); 61 62 if ($resultValid === false) { 63 echo "=> preg_match() 関数自体が失敗を返しました (予期しない)。\n"; 64 } elseif ($resultValid === 0) { 65 echo "=> パターンが見つかりませんでした。\n"; 66 } else { 67 echo "=> パターンが見つかりました。\n"; 68 } 69 70 $noErrorCode = preg_last_error(); 71 $noErrorMessage = preg_last_error_msg(); 72 73 echo "\n--- エラーなしの場合の詳細 ---\n"; 74 echo "preg_last_error() が返したエラーコード: " . $noErrorCode . "\n"; 75 echo "preg_last_error_msg() が返したエラーメッセージ: " . $noErrorMessage . "\n"; 76 if ($noErrorCode === PREG_NO_ERROR) { 77 echo "=> preg_last_error() はエラーを検出しませんでした。\n"; 78 } else { 79 echo "=> preg_last_error() は正規表現処理中にエラーを検出しました (予期しない)。\n"; 80 } 81 echo "--------------------\n"; 82} 83 84// 関数を実行してデモンストレーションを開始 85demonstratePregErrors(); 86 87?>
PHPのpreg_last_error関数は、正規表現処理中に発生した最後のエラーコードを取得するために使われます。この関数は引数を取らず、エラーの種類を示す整数値を返します。また、PHP 8.0以降で利用可能なpreg_last_error_msg関数は、そのエラーコードに対応する人間が読めるエラーメッセージを文字列として返します。
サンプルコードでは、まず閉じ括弧が不足している不正な正規表現パターンをpreg_match関数に渡して、意図的にエラーを発生させています。このような場合、preg_matchは正規表現の実行に失敗し、falseを返します。このfalseが返された後にpreg_last_error()を呼び出すと、具体的なエラーコード(例: PREG_DELIMITER_NOT_FOUNDなど)を取得でき、preg_last_error_msg()からはそのエラーコードに対応する詳細なメッセージを確認できます。これにより、正規表現のどこに問題があったのかを特定する手助けとなります。
次に、有効な正規表現パターンでpreg_matchを実行した場合の挙動も示しています。この場合、preg_matchは正常に実行され、preg_last_error()はエラーがないことを示すPREG_NO_ERROR(値は0)を返し、preg_last_error_msg()は「No error」といったメッセージを返します。正規表現関数がfalseを返した場合でも、preg_last_error()が必ずしもエラーコードを返すとは限らないため、両方を組み合わせて確認することが、堅牢なエラーハンドリングを行う上で重要です。
preg_matchなどの正規表現関数が失敗(false)を返した場合、必ず直後にpreg_last_error()を呼び出し、エラーコードを確認してください。これは、正規表現エラー情報が次の正規表現関数の実行で上書きされるためです。サンプルコードの@演算子は警告メッセージの表示を一時的に抑制しますが、本番環境ではエラーログなどでエラーを適切に監視することが重要です。PHP 8.0以降ではpreg_last_error_msg()を使って、より人間が理解しやすいエラーメッセージも取得できます。preg_last_error()が0(PREG_NO_ERROR)であっても、正規表現関数自体がfalseを返す場合があるため、両方の戻り値を確認することが堅牢なコードへの第一歩となります。