概要
sanitize_user関数は、与えられた文字列をユーザー名として安全に使用できるようにサニタイズ（消毒）するための関数です。この関数は、特にユーザー名の入力に関して不正なデータや潜在的なセキュリティリスクを排除することを目的としており、以下のような機能を実装する際によく使われます。
- ユーザー名の登録時のバリデーション
- フォームからのユーザー名の入力処理
- データベースへのユーザー名の保存時
- ワードプレスのユーザー管理インターフェースでのユーザー名表示
- AJAXリクエストによるユーザー名のサニタイズ
- REST APIエンドポイントでのユーザー名処理
- プラグイン開発におけるユーザー名の安全性確保
- ウェブサイトのエクスポート・インポート処理
構文
string sanitize_user( string $username, bool $strict = false )
パラメータ
$username: サニタイズされたユーザー名として返される文字列。$strict: （オプション）真偽値で、厳密なサニタイズを行うかどうかを決定（デフォルトはfalse）。
戻り値
サニタイズされたユーザー名として返される文字列。
関連する関数
バージョン
この関数は、WordPress 1.5.0以降で使用可能です。
コアファイルのパス
wp-includes/formatting.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: ユーザー名の基本的なサニタイズ
このサンプルコードは、ユーザー名をサニタイズする基本的な使用例です。ユーザー名が正しい形式かどうかを確認し、サニタイズされたユーザー名を取得します。
$username = "User@Name#123";
$sanitized_username = sanitize_user($username);
echo $sanitized_username; // 出力: username123
引用元: https://developer.wordpress.org/reference/functions/sanitize_user/
サンプルコード2: 厳密なサニタイズ
この例では、$strictパラメータをtrueに設定して、より厳密にサニタイズを行います。
$username = "User@Name#123";
$sanitized_username = sanitize_user($username, true);
echo $sanitized_username; // 出力: ""
引用元: https://developer.wordpress.org/reference/functions/sanitize_user/
サンプルコード3: サニタイズ後のユーザー名のチェック
このコードは、サニタイズ処理の後に特定の条件を満たすかどうかをチェックします。
$username = "User@Name#123";
$sanitized_username = sanitize_user($username);
if (username_exists($sanitized_username) === null) {
echo "このユーザー名は使用可能です。";
} else {
echo "このユーザー名は既に存在します。";
}
引用元: https://developer.wordpress.org/reference/functions/sanitize_user/
サンプルコード4: フォームの入力処理
このコードスニペットは、フォームからユーザー名を取得し、サニタイズする方法を示しています。
if ($_SERVER["REQUEST_METHOD"] == "POST") {
$username = $_POST['username'];
$sanitized_username = sanitize_user($username);
// 次の処理に進む
}
引用元: https://developer.wordpress.org/reference/functions/sanitize_user/
サンプルコード5: AJAXリクエスト内での使用
この例では、AJAXリクエストの中で、ユーザー名をサニタイズする方法を示しています。
add_action('wp_ajax_check_username', 'check_username');
function check_username() {
$username = sanitize_user($_POST['username']);
// サニタイズされたユーザー名を用いて処理を続ける
}
引用元: https://developer.wordpress.org/reference/functions/sanitize_user/