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

【PHP8.x】preg_last_error_msg()関数の使い方

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

作成日: 更新日:

基本的な使い方

preg_last_error_msg関数は、PHPの正規表現(PCRE: Perl互換正規表現)関数で最後に発生したエラーのメッセージを取得する関数です。

PHPでpreg_matchやpreg_replaceといった正規表現を扱う関数を使用する際、正規表現のパターンやオプションの指定に誤りがあるとエラーが発生することがあります。これらの正規表現関数は、エラー発生時にfalseなどを返すことで問題があったことを示しますが、具体的にどのようなエラーであったかの詳細までは直接教えてくれません。

preg_last_error_msg関数は、このような場合に役立ちます。正規表現関数を実行した直後にこの関数を呼び出すことで、最後に発生したエラーの内容を詳細な文字列として取得できます。例えば、「無効なパターンが指定されました」や「未知の修飾子です」といった、人間が理解しやすい具体的なメッセージが返されます。

通常、この関数はpreg_last_error()関数と組み合わせて使用されます。preg_last_error()でエラーコードを確認し、エラーが発生していれば、その詳細なメッセージをpreg_last_error_msg()で取得します。これにより、プログラムのデバッグやエラーハンドリングが効率的に行えます。エラーが発生していない場合は空の文字列が返されます。

構文(syntax)

1<?php
2$error_message = preg_last_error_msg();
3?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

正規表現関数実行時の直近のエラーメッセージを文字列として返します。エラーが発生しなかった場合は空文字列を返します。

サンプルコード

preg_last_error_msgでPCREエラーメッセージを取得する

1<?php
2
3/**
4 * preg_last_error_msg 関数の使用例
5 *
6 * このコードは、直近の PCRE (Perl Compatible Regular Expressions) 関数呼び出しで
7 * 発生したエラーのメッセージを取得する方法を示します。
8 * エラーが発生しない場合と、意図的にエラーを発生させた場合の動作を比較します。
9 *
10 * PHP 8 では、エラーがない場合に 'No error' という文字列が返されます。
11 */
12
13echo "--- 1. 不正な正規表現パターンでエラーを発生させる例 ---\n";
14
15// 意図的に不正な正規表現パターンを作成します。
16// 例: 開きブラケット '[' が閉じられていないため、パターンが無効です。
17$invalidPattern = '/abc[';
18$subject = 'abcdefghijklmnopqrstuvwxyz';
19
20// 不正なパターンで preg_match を実行します。
21// この呼び出しは失敗し、内部的にPCREエラー状態を設定します。
22// preg_match 自体は false を返しますが、致命的なエラーにはなりません。
23@preg_match($invalidPattern, $subject); // @ をつけて警告メッセージを表示しないようにします。
24
25// 直近の PCRE エラーメッセージを取得します。
26$errorMessage = preg_last_error_msg();
27
28if ($errorMessage !== 'No error') {
29    echo "エラーが発生しました。\n";
30    echo "取得されたエラーメッセージ: '" . $errorMessage . "'\n";
31} else {
32    echo "エラーは発生しませんでした (このメッセージは通常、不正なパターンでは表示されません)。\n";
33}
34
35echo "\n--- 2. 正常な正規表現パターンでエラーがないことを確認する例 ---\n";
36
37// 正常な正規表現パターンを作成します。
38$validPattern = '/abc/';
39$matches = [];
40
41// 正常なパターンで preg_match を実行します。
42// この呼び出しは成功し、エラーは発生しません。
43if (preg_match($validPattern, $subject, $matches)) {
44    echo "パターン '{$validPattern}' がテキストにマッチしました。\n";
45    // var_dump($matches); // マッチした結果を表示したい場合はコメントを外してください。
46} else {
47    echo "パターン '{$validPattern}' はテキストにマッチしませんでした。\n";
48}
49
50// 直近の PCRE エラーメッセージを再度取得します。
51// エラーがないため、PHP 8 では 'No error' が返されます。
52$noErrorMessage = preg_last_error_msg();
53
54if ($noErrorMessage === 'No error') {
55    echo "エラーは発生しませんでした。\n";
56    echo "取得されたメッセージ: '" . $noErrorMessage . "'\n";
57} else {
58    echo "予期せぬエラーが発生しました: '" . $noErrorMessage . "'\n";
59}
60
61?>

PHPのpreg_last_error_msg関数は、直前に実行されたPCRE(Perl Compatible Regular Expressions)関連の関数呼び出しで発生したエラーのメッセージを取得するために使用されます。この関数は引数を持ちません。戻り値はエラーメッセージを表す文字列で、PHP 8からは、エラーが何も発生していない場合に「No error」という文字列が返されるようになりました。

サンプルコードでは、まず意図的に不正な正規表現パターン(例えば、閉じられていない開きブラケットを含む/abc[)を使用してpreg_match関数を実行し、PCREエラーを発生させています。この不正な実行の直後にpreg_last_error_msg()を呼び出すと、「Unmatched '[' at offset 4」のような具体的なエラーメッセージが取得され、正規表現の何が問題だったのかを特定できます。

次に、/abc/のような正常な正規表現パターンでpreg_matchを実行する例を示しています。この場合、PCRE関数は正常に処理を完了するため、preg_last_error_msg()を呼び出すと「No error」というメッセージが返されます。これにより、直前の正規表現処理でエラーが発生しなかったことを明確に確認できます。

この関数は、正規表現処理で予期せぬ問題が発生した際に、その原因を特定し、デバッグやエラーハンドリングを行う上で非常に役立ちます。

preg_last_error_msg関数は、直前に実行された正規表現(PCRE)関連関数のエラーメッセージを取得する際に利用します。PHP 8以降では、エラーが発生しなかった場合に「'No error'」という特定の文字列が返されるため、この文字列と比較してエラーの有無を判断してください。エラーをチェックしたいPCRE関数の直後に呼び出すことが重要です。サンプルコードで利用されている@演算子は、PHPの警告メッセージの表示を抑制するだけで、エラー自体を解決するものではありません。開発中はエラーの内容を把握するためにも、安易な使用は避け、本番環境で適切にエラーハンドリングを行った上で利用を検討してください。正規表現関数自体の戻り値と本関数を組み合わせることで、エラー発生時の原因特定に役立ち、より安全なコード作成につながります。

preg_last_error_msgでエラーメッセージを取得する

1<?php
2
3/**
4 * preg_last_error_msg() 関数の使用例
5 * 直近の PCRE (Perl Compatible Regular Expressions) 正規表現関数の実行で発生したエラーのメッセージを取得します。
6 * この関数は引数を取りません。
7 *
8 * エラーが発生した場合と、エラーが発生しなかった場合の挙動を示します。
9 */
10function demonstratePregLastErrorMsg(): void
11{
12    echo "--- 無効な正規表現パターンでエラーを発生させる例 ---\n";
13
14    // 意図的に不正な正規表現パターンを作成します。
15    // このパターンは閉じ括弧 ')' が足りないため、構文エラーになります。
16    $invalidPattern = '/(hello/';
17    $subject = 'hello world';
18
19    // preg_match() を実行し、正規表現エラーを発生させます。
20    // エラーが発生すると、preg_match() は false を返します。
21    $result = preg_match($invalidPattern, $subject);
22
23    // preg_last_error_msg() を呼び出して、直近のエラーメッセージを取得します。
24    $errorMessage = preg_last_error_msg();
25
26    if ($result === false) {
27        echo "preg_match() が失敗しました。\n";
28        echo "エラーメッセージ: " . $errorMessage . "\n";
29    } else {
30        // このパスは通常実行されません(不正なパターンではfalseになるため)
31        echo "preg_match() は成功しました (予期せぬ結果)。\n";
32        echo "エラーメッセージ (成功時): '" . $errorMessage . "'\n";
33    }
34
35    echo "\n--- 有効な正規表現パターンでエラーが発生しない例 ---\n";
36
37    // 有効な正規表現パターンを作成します。
38    $validPattern = '/world/';
39    $validSubject = 'hello world';
40
41    // preg_match() を実行し、成功させます。
42    // マッチすれば 1、マッチしなければ 0 を返します。
43    $resultValid = preg_match($validPattern, $validSubject);
44
45    // preg_last_error_msg() を呼び出して、エラーメッセージを取得します。
46    // エラーがない場合、通常は空文字列を返します。
47    $errorMessageValid = preg_last_error_msg();
48
49    if ($resultValid !== false) {
50        echo "preg_match() が成功しました。\n";
51        echo "マッチ結果: " . ($resultValid ? 'マッチしました' : 'マッチしませんでした') . "\n";
52        echo "エラーメッセージ (成功時): '" . $errorMessageValid . "' (エラーがない場合は空文字列です)\n";
53    } else {
54        // このパスは通常実行されません(有効なパターンではfalseにならないため)
55        echo "preg_match() が失敗しました (予期せぬ結果)。\n";
56        echo "エラーメッセージ: " . $errorMessageValid . "\n";
57    }
58}
59
60// 関数を実行します。
61demonstratePregLastErrorMsg();

PHPの preg_last_error_msg() 関数は、直前のPCRE正規表現関数の実行でエラーが発生した場合に、その詳細なメッセージを取得します。この関数は引数を持たず、エラーメッセージを表す文字列を返します。エラーがない場合は空文字列が戻り値となります。

サンプルコードでは、まず閉じ括弧が足りない不正な正規表現パターンを用いて preg_match() を実行し、意図的にエラーを発生させています。preg_match() は正規表現エラーが発生すると false を返すため、その直後に preg_last_error_msg() を呼び出すことで、エラー内容を示す具体的なメッセージが取得され、表示されます。

次に、有効な正規表現パターンで preg_match() を実行する例を示しています。この場合 preg_match() は正常に処理を行い、マッチ結果を返します。エラーは発生していないため、preg_last_error_msg() を呼び出しても戻り値は空文字列となります。

このように preg_last_error_msg() は、正規表現の処理が失敗した際、エラー内容の把握と問題解決に役立ちます。

preg_last_error_msg関数は、直前に実行されたpreg_系の正規表現関数で発生したエラーの具体的なメッセージを取得します。この関数は引数をとりません。正規表現関数が失敗しfalseを返した場合、その直後にこの関数を呼び出すことで、エラーの原因となるメッセージが得られます。エラーが発生しなかった場合は空文字列を返しますので、preg_関数の戻り値と合わせてエラーの有無を判断することが重要です。これにより、意図しない正規表現の挙動を特定し、修正する際に役立ちます。

関連コンテンツ