概要
is_email 関数は、指定された文字列がメールアドレス形式か調べるために使用されます。この関数は、ユーザーからの入力が正しいメールアドレスかどうかを確認する際に非常に便利です。具体的には、以下のような場面でよく使われます：
- フォームからの入力チェック
- ユーザー登録プロセスのバリデーション
- メール通知の送信先アドレスの確認
- コメント投稿時のメールアドレスチェック
- パスワードリセット機能の確認
- ニュースレター登録時のメールアドレスチェック
- カスタムユーザープロファイルの更新処理
- 管理画面でのユーザー管理機能
構文
is_email( string $email ) : mixed
パラメータ
- $email (string): チェックするメールアドレス
戻り値
- メールアドレスが有効な形式であれば、そのメールアドレスを返します。
- 無効であれば、
falseを返します。
関連する関数
使用可能なバージョン
is_email関数は WordPress のコアに含まれています。
コアファイルのパス
wp-includes/pluggable.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプル1: メールアドレスのバリデーション
$email = "test@example.com";
if (is_email($email)) {
echo "有効なメールアドレスです";
} else {
echo "無効なメールアドレスです";
}
このコードは、指定されたメールアドレスが有効な形式であるかをチェックし、有効な場合にはメッセージを表示します。引用元: WordPress Codex
サンプル2: フォームの検証
if ($_SERVER["REQUEST_METHOD"] == "POST") {
$email = $_POST['email'];
if (!is_email($email)) {
echo "メールアドレスが無効です。再入力してください。";
}
}
このコードは、POSTリクエストで受け取ったメールアドレスが正しい形式かを確認し、無効な場合にはエラーメッセージを表示します。引用元: WordPress Codex
サンプル3: ユーザー登録時のメールアドレスチェック
function validate_user_registration($email) {
if (!is_email($email)) {
return new WP_Error('invalid_email', '無効なメールアドレスです。');
}
return true;
}
この関数は、ユーザー登録時のメールアドレスが有効かどうかをチェックし、無効な場合にはエラーを返します。引用元: WordPress Codex
サンプル4: コメント投稿時のメールアドレス検証
add_filter('preprocess_comment', 'check_comment_email');
function check_comment_email($commentdata) {
if (!is_email($commentdata['comment_author_email'])) {
wp_die("メールアドレスが無効です。");
}
return $commentdata;
}
このコードは、コメント投稿時にメールアドレスをチェックし、無効な場合にはエラーメッセージを表示します。引用元: WordPress Codex
サンプル5: ニュースレター登録
function subscribe_newsletter($email) {
if (!is_email($email)) {
return "無効なメールアドレスです。";
}
// メールアドレスをニュースレターリストに追加するロジック
return "登録成功です。";
}
この関数は、ニュースレターの登録処理を行い、メールアドレスの有効性もチェックします。無効な場合にはメッセージを返します。引用元: WordPress Codex