概要
wp_signon関数は、ユーザーの認証処理を行うための関数です。この関数は、指定されたユーザー資格情報を使用してWordPressにログインさせるのに役立ちます。特に、カスタムログインフォームや、非標準のログインプロセスを実装する際によく使用されます。
この関数の使用例：
1. カスタムログインページの作成
2. フロントエンドからのログインプロセスの作成
3. プラグインとの統合でのユーザー認証
4. AJAXを使用したログイン処理
5. パスワードリセット後の自動ログイン機能
6. メールリンクからのワンクリックログイン
7. 様々なログインオプションの統合
8. セッション管理機能の拡張
構文
$result = wp_signon( $credentials, $secure_cookie );
パラメータ
$credentials(array) – ユーザーのログイン情報を含む連想配列。主に ‘user_login’ と ‘user_password’ を含める必要があります。$secure_cookie(boolean) – 安全なクッキーを使用するかどうかを指定します。デフォルトはfalse。
戻り値
WP_User|WP_Error– ログインに成功した場合はWP_Userオブジェクトを返し、失敗した場合はWP_Errorオブジェクトを返します。
関連する関数
使用可能なバージョン
wp_signonは、WordPress 2.5以降で利用可能です。
コアファイルのパス
wp-includes/user.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 |
wp_signon関数は現時点で特定のバージョンで非推奨または削除されていません。