Tech
Contact Form 7 確認用メールアドレスの一致チェック
確認用メールアドレスの再入力は本体に機能がなく、フィルタで足します。
6.2.1の配布zipを実取得してPHP 8.3.6で動かし、一致しないのに送信される・送信できないのにエラーが出ない、という典型的な失敗4つを再現したうえで、そのまま貼れるコードを置きました。
受託で管理しているサイトで「確認用メールアドレスの欄を増やしてほしい」という依頼がありました。
入力欄を増やすだけならフォームにタグを1行足すだけです。
ただし、2つの欄が同じ値かどうかを見る処理は Contact Form 7 本体に入っていません。
そして検索で見つかるコードの多くは、そのまま貼っても動かないか、動いているように見えて止めていないかのどちらかです。
この記事は downloads.wordpress.org から 6.2.1(zipのmd5 b88e4ac621376d9be9a2557843d0f0d9・368,610バイト)と 6.1.7(zipのmd5 4940b9901989a72cc14b5446b8268f61・297,238バイト)の配布zipを実取得し、本体の WPCF7_Validation と form-tag のクラスをそのまま読み込んで PHP 8.3.6 で動かし、失敗パターンを再現した結果です。
結論:フィルタ1本で足します
先に動くコードです。
フォーム側は次の2行で、your-email が本来の入力欄、your-email-confirm が確認用です。
[email* your-email autocomplete:email]
[email* your-email-confirm autocomplete:email]
functions.php(または自作プラグイン)に次を足します。
add_filter( 'wpcf7_validate_email*', 'fl_cf7_confirm_email', 20, 2 );
add_filter( 'wpcf7_validate_email', 'fl_cf7_confirm_email', 20, 2 );
function fl_cf7_confirm_email( $result, $tag ) {
if ( 'your-email-confirm' !== $tag->name ) {
return $result;
}
$main = isset( $_POST['your-email'] ) ? trim( (string) wp_unslash( $_POST['your-email'] ) ) : '';
$confirm = isset( $_POST['your-email-confirm'] ) ? trim( (string) wp_unslash( $_POST['your-email-confirm'] ) ) : '';
// 空欄のときは必須エラーに任せる(二重にメッセージを出さない)
if ( '' === $confirm ) {
return $result;
}
if ( 0 !== strcasecmp( $main, $confirm ) ) {
$result->invalidate( $tag, 'メールアドレスが一致しません。もう一度ご確認ください。' );
}
return $result;
}
このコードを本体の WPCF7_Validation と一緒に PHP 8.3.6 で動かした結果が次です。
本体の validate() と同じ順序(SWVのスキーマ検証を先に通してからフィルタを呼ぶ)で再現しています。
| 入力 | 判定 | 出るメッセージ |
|---|---|---|
両方 abe@example.com | 通る | - |
Abe@Example.com と abe@example.com | 通る | - |
abe@example.com と abee@example.com | 止まる | メールアドレスが一致しません。もう一度ご確認ください。 |
| 確認用の前後に空白あり | 通る | - |
| 確認用が空 | 止まる | 入力してください。(必須エラー) |
大文字小文字の違いを通しているのは strcasecmp() を使っているためです。
メールアドレスのローカル部は規格上は大文字小文字を区別しますが、実運用でそれを別物として扱うメールサーバーはほぼなく、打ち間違いではないものを打ち間違い扱いして離脱させる損失のほうが大きいため、一致として扱っています。
前後の空白も trim() で落としています。
スマートフォンの予測変換で末尾に空白が入るのは珍しくありません。
なぜ本体任せにできないのかも確認しておきます。
入力チェックの土台であるSWV(Schema-Woven Validation)のルールは 6.2.1 では外部パッケージに移っており、RequiredRule EmailRule MaxLengthRule TelRule など24ファイルが入っています。
そのすべてが1つのフィールドを単体で見るルールで、2つのフィールドを比べるルールはありません。
つまりスキーマでは表現できない種類のチェックなので、フィルタで足すのが素直な設計になります。
落とし穴1:wpcf7_validate_email だけでは呼ばれません
もっとも多い失敗です。
本体の includes/submission.php の validate() は、フォーム内のタグを順に回しながらこう呼びます。
foreach ( $tags as $tag ) {
$type = $tag->type;
$result = apply_filters( "wpcf7_validate_{$type}", $result, $tag );
}
ここで使われている $tag->type は、必須指定のアスタリスクを含んだままの型名です。
本体の WPCF7_FormTag::is_required() が str_ends_with( $this->type, '*' ) で必須を判定していることからも分かります。
アスタリスクを除いた型名は basetype という別のプロパティに入っています。
実際に [text* your-name] [email* your-email] [email* your-email-confirm] を本体のタグ解析に通すと、次のように分かれました。
| type | basetype | name |
|---|---|---|
text* | text | your-name |
email* | email | your-email |
email* | email | your-email-confirm |
そのうえで wpcf7_validate_email と wpcf7_validate_email* の両方にコールバックを登録して流すと、発火したのは wpcf7_validate_email* だけでした。
必須のメール欄に対して wpcf7_validate_email は一度も呼ばれません。
古い記事のコードが「貼ったのに何も起きない」のはここが理由です。
確認用の欄を任意項目にする可能性も考えて、上のコードでは両方に登録しています。
あわせて書いておくと、wpcf7_text_validation_filter という関数名を参照している解説は、もう当てになりません。
6.1.7 と 6.2.1 のどちらの配布物にもこの関数は存在せず、テキスト系の入力チェックは wpcf7_swv_create_schema 経由のSWVルールに移っています。
本体のアップデートで何が消えたかはContact Form 7 6.2はPHP8.3必須|更新が止まる条件にまとめてあります。
落とし穴2:フィールド名を文字列で渡すと、打ち間違いが無言で消えます
次に多い失敗です。
エラー登録をこう書いているコードをよく見ます。
// 危険な書き方
$result->invalidate( 'your-email-confirm', 'メールアドレスが一致しません。' );
本体の WPCF7_Validation::invalidate() は、第1引数が文字列だった場合にフォームの中から同じ名前のタグを探し直します。
} elseif ( is_string( $context ) ) {
$tags = wpcf7_scan_form_tags( array( 'name' => trim( $context ) ) );
$tag = $tags ? new WPCF7_FormTag( $tags[0] ) : null;
}
$name = ! empty( $tag ) ? $tag->name : null;
if ( empty( $name ) or ! wpcf7_is_name( $name ) ) {
return;
}
見つからなければ return です。
例外も警告もログも出ません。
フィールド名を your-email-conf と打ち間違えた状態で実行すると、判定結果は次のようになりました。
invalidate('your-email-conf', 'メールアドレスが一致しません')
=> is_valid: true / invalid_fields: []
一致していないのに、フォームはそのまま送信されます。
確認用の欄を付けた意味が消えるうえ、テストでは「エラーが出ないから通ったのだろう」と誤解しやすい、いちばん危ない壊れ方です。
フィルタの第2引数で渡ってくる $tag をそのまま使えば、名前を文字で書く機会そのものが無くなります。
確認用の欄を足す前に
入力ミスを根本から減らすなら、確認画面のほうが効きます
確認用メールアドレスは「2回打たせる」対策です。入力内容をまとめて見せてから送信させる確認画面のほうが、メールアドレス以外の打ち間違いにも効きます。Frontierline Forms は Contact Form 7 の送信前の確認画面、送信内容のデータベース保存とCSV書き出し、マルチステップを1つのプラグインにまとめたもので、確認画面は無料版に含まれています。
落とし穴3:送信できないのに、エラーが表示されません
落とし穴2の裏返しです。invalidate() に配列を渡した場合、本体はその配列から直接タグを組み立てます。
フォーム内に実在するかどうかは見ません。
$result->invalidate(
array( 'type' => 'email*', 'name' => 'your-email-conf' ),
'メールアドレスが一致しません。'
);
これを動かすと、存在しないフィールド名のままエラーが登録されました。
=> is_valid: false
invalid_fields: {"your-email-conf":{"reason":"メールアドレスが一致しません。","idref":null}}
送信は止まります。
ところが画面にメッセージが出ません。
フロント側のJavaScript(includes/js/index.js)は、サーバーから返ってきたエラーを次のように配置します。
r.querySelectorAll(`.wpcf7-form-control-wrap[data-name="${t}"]`).forEach( ... )
メール欄のHTMLは <span class="wpcf7-form-control-wrap" data-name="your-email-confirm"> の形で出力されるため、data-name が一致する入れ物が無いフィールド名のエラーは差し込む先が見つからず、どこにも表示されません。
読み上げ用の .screen-reader-response のリストには追加されるので、画面に見えるのは「入力内容に問題があります」という全体メッセージだけになります。
利用者からすると「何も赤くならないのに送信できない」という状態です。
これもフィルタの $tag をそのまま渡していれば起こりません。
入力チェック全般のフィルタの書き方はContact Form 7に独自バリデーションを追加する方法に整理してあります。
落とし穴4:先に入ったメッセージが勝ちます
invalidate() の末尾にはこのガードがあります。
if ( $this->is_valid( $name ) ) {
// ここで初めて invalid_fields に登録される
}
同じフィールドに2回エラーを登録しても、残るのは1回目だけです。
実際に同じタグへ2回登録すると、2回目は無視されました。
1回目「入力してください。」→ 2回目「メールアドレスが一致しません。」
=> {"your-email-confirm":{"reason":"入力してください。","idref":null}}
そして本体の validate() は、SWVのスキーマ検証を先に走らせ、そのあとで wpcf7_validate_{型} のフィルタを呼ぶ順番です。
確認用の欄を [email* ...] で必須にしているなら、空欄のときは必須エラーが先に入ります。
あとから「一致しません」を登録しても表示されません。
ここで必須チェックを自前に寄せたくなりますが、やめたほうがよいです。
必須と形式の判定はSWVに任せたままにして、フィルタ側は「確認用が空なら何もせずに戻る」と書くだけで済みます。
上のコードで if ( '' === $confirm ) { return $result; } を入れているのはこのためです。
二重に実装しないほうが、本体の更新に巻き込まれません。
入力中に気づかせる
サーバー側のチェックは送信ボタンを押したあとに働きます。
入力している最中に気づかせたい場合は、ブラウザ側に数行足します。
本体のJavaScriptは change イベントで wpcf7.validate() を呼び、REST API の feedback/schema から取得したSWVスキーマを使って即時チェックをしています。
つまり即時チェックが見ているのはスキーマだけで、PHPのフィルタは通りません。
一致判定はスキーマで表現できないため、ここは自前で書く領域です。
document.addEventListener( 'DOMContentLoaded', () => {
const main = document.querySelector( 'input[name="your-email"]' );
const conf = document.querySelector( 'input[name="your-email-confirm"]' );
if ( ! main || ! conf ) {
return;
}
const wrap = conf.closest( '.wpcf7-form-control-wrap' );
let tip = null;
const check = () => {
const a = main.value.trim().toLowerCase();
const b = conf.value.trim().toLowerCase();
const mismatch = b !== '' && a !== b;
if ( mismatch && ! tip ) {
tip = document.createElement( 'span' );
tip.className = 'fl-confirm-tip';
tip.setAttribute( 'aria-live', 'polite' );
tip.textContent = 'メールアドレスが一致しません。';
wrap.appendChild( tip );
} else if ( ! mismatch && tip ) {
tip.remove();
tip = null;
}
};
conf.addEventListener( 'blur', check );
main.addEventListener( 'blur', check );
} );
クラス名を本体の wpcf7-not-valid-tip にしていないのは意図的です。
本体はエラー表示を消すときに .wpcf7-not-valid-tip を remove() するので、同じクラス名を使うと自前の表示が本体の処理に巻き込まれて消えたり、逆に消えるべきときに残ったりします。
自前のクラスにしておけば干渉しません。
setCustomValidity() も使っていません。
本体が同じ入力要素に対してこれを呼ぶため、どちらの文言が残るかが操作順に左右されます。
貼り付け禁止にはしません
確認用の欄を作るとき、「コピー&ペーストを禁止すれば打ち間違いが防げる」という発想が出ます。
実装としてはおすすめしません。
貼り付けを封じると、パスワード管理ソフトやブラウザの自動入力が効かなくなります。
スマートフォンでは長いメールアドレスを手で2回打たせることになり、入力途中の離脱が増えます。
打ち間違いそのものは減らず、手入力の誤りが増える方向に働きます。
上のフォーム側のタグで両方に autocomplete:email を付けているのは逆の発想です。
自動入力が効く状態を保ったまま、サーバー側で一致を見ます。
自動入力が働けば、そもそも2つの欄は同じ値で埋まります。
まとめ
- 確認用メールアドレスの一致チェックは本体に無く、SWVの24ルールにもフィールド同士を比較するものは無いため、フィルタで足します
- フィルタ名は
wpcf7_validate_email*。必須指定のアスタリスクは型名に含まれるので、wpcf7_validate_emailだけでは呼ばれません invalidate()の第1引数は、フィルタが渡してくる$tagをそのまま使います。文字列で名前を書くと、打ち間違いが無言で無効化され、不一致でも送信されます- 確認用が空のときは一致判定をせずに戻します。SWVがフィルタより先に走り、先に入ったメッセージが残るためです
- 入力中に気づかせる即時チェックは、本体のスキーマ検証では行われないので自前のJavaScriptで足します。クラス名は本体と分けます
- 貼り付け禁止ではなく
autocompleteを効かせる方向で組みます
打ち間違い対策として確認用の欄を増やすより、送信前に入力内容をまとめて見せる確認画面のほうが広く効きます。
確認画面の作り方はContact Form 7 に確認画面を追加する方法|コード不要で実装するにまとめてあります。
Frontierline Forms
確認画面・DB保存・CSV書き出し・マルチステップを1つのプラグインで
確認用メールアドレスのような小さな追加も、functions.php に積み上がると本体更新のたびに点検が必要になります。Frontierline Forms は Contact Form 7 の送信前の確認画面、送信内容のデータベース保存とCSV書き出し、マルチステップを無料版に含んでいます。自前実装を減らしたい方はこちらからどうぞ。